Foundations Lib

Vanilla `transitionableProps` is pretty straight forward. You specify a duration in hours, how long before it starts, and you move on with your life. In-game that translates to a specific amount of hours you wait before the item transitions.

Foundations Lib makes this entire process more dynamic, and apply to thrown items.

 

New Attributes

transitionTimescale

This attribute scales the freshHours and and transitionHours fields of transitionableProps to represent days, months, or years. When applied, it multiplies the original value by the number of hours in each respectively.

This takes either a string or an object where keys are the type of the transitionableProp it affects.

Examples:

{
    "attributes": {
        // Adjusts every transitionableProp value to be scaled by the hours in a month.
        // If months are 9 days long, that means it becomes `originalValue * 9 * hoursInADay`
        "transitionTimescale": "Month"
    }
}

{
    "attributes": {
        "transitionTimescale": {
            "default": "Day", // The default scale to use if the specific transition type is not specified
            "Dry": "Year" // Scales by the number of hours in a year
        }
    }
}

 

transitionEnvironment

This attribute modifies how quickly an ItemStack transitions based off the environment in its location. This includes temperature, rainfall, sunlight, current light level (max of sunlight or blocklight), and whatever fluid it happens to be at its location.

These are specified on a per-type basis, and only the environment types specified are checked. The amount applied to the transitionedTime is the average of the values produced by the environmental checks.

All values underneath the environment check (temperature, sunlight, liquids), are optional.

 

Example:

{
    "attributes": {
        "transitionEnvironment": {
            "Dry": {
                // Pulls climate temperature at its location to modify the transitionedHours adjustment value
                "temperature": {
                    // Defaults to -20
                    "min": -20,
                    // Defaults to 40
                    "max": 40,
                    // The closer the temperature is to sweetSpot, the closer to 1 the produced modifier is
                    // Defaults to (min + max) / 2
                    "sweetSpot": 35,
                    // Adds a flat value to the modifier
                    // Defaults to 0.0
                    "adjustment": 0,
                    // Multiplies the modifier by this value before the adjustment is applied
                    // Defaults to 1.0
                    "scale": 1,
                    // Subtrats 1.0 from the modifier to invert the effects of sweetSpot
                    // Applied before adjustment or scale
                    // Defaults to false
                    "invert": false,
                    // Allows values beyond the 0 to 1 range to be produced. Will cause weird values when paired with invert
                    "allowOverflow": false,
                    // When allowOverflow is false and the temperature falls outside the allowed range, this converts
                    // the item to this item
                    // Only gets applied if allowOverflow is false
                    "ruinStack": {
                        "type": "item",
                        "code": "stick"
                    },
                    // When the itemstack transitions to the above ruinStack, this sound is played
                    // If no value is provided, no sound is played
                    "transitionSound": "game:sizzle"
                },
                // Pulls rainfall values. 0 is no rain
                "rainfall": {
                    // These are the default values that are different from temperature
                    // Note: Rainfall can only produce a value between 0 and 1, inclusive
                    "min": 0,
                    "max": 1
                },
                // Pulls current sunlight values
                "sunlight": {
                    // These are the default values that are different from temperature
                    // Note: Sunlight can only produce a value between 0 and 32, inclusive
                    "min": 0,
                    "max": 32
                },
                // Pulls current sunlight and block light values, using whichever is greater
                "anylight": {
                    // These are the default values that are different from temperature
                    // Note: anylight can only produce a value between 0 and 32, inclusive
                    "min": 0,
                    "max": 32
                },
                // This can contain the asset location of any fluid
                "fluids": {
                    // Used when the itemstack is located in water
                    "game:water": {
                        // If this is specified, immediately converts the stack to this item
                        "ruinStack": {"type": "item", "code": "stick"},
                        // When the itemstack transitions to the above ruinStack, this sound is played
                        // If no value is provided, no sound is played
                        "transitionSound": "game:sizzle"
                        // If ruinStack is not specified, adds this flat value to the modifier
                        // Defaults to 0
                        "rateModifier": 0.5
                    }
                }
            }
        }
    }
}