FoodStat Definition

HomeModdingReferenceSBCFoodStat Def

Overview

Inherits

• EntityStat Definition
• DefinitionBase

Requires an xsi:type attribute:

<Stat xsi:type="MyObjectBuilder_FoodStatDefinition">

Related: EntityStat Definition | FoodStat Definition | RadiationStat Definition | RadiationImmunityStat Definition

Elements

 ↑   🔗 

DecayRate <DecayRate>	Type: Single	Default: 0.062
Amount of stat's unit (not ratio) to decrease every exactly 100 ticks (~1.66s). It will not decay when the character is sitting in a CryoChamber. This value is multiplied by world's FoodConsumptionRate. Cannot be smaller than 0 or larger than 1. Can be 0 to disable. Formulas to calculate: Time from DecayRate: Minutes = <MaxValue> / (36 * DecayRate * FoodConsumptionRate) DecayRate from Time at 1.0 (fast) FoodConsumptionRate: DecayRate = <MaxValue> / Minutes / 36. For other FoodConsumptionRate values, divide your Minutes by that before inputting into the formula.
CriticalLevel <CriticalLevel>	Type: Single	Default: 0.2
When this stat's value ratio gets below this ratio (0.1 is 10%), multiple things happen: <MovementSpeedDebuff> starts to be applied (see there for formulas). If <EnableSprintingOnCritical> is off, character can no longer sprint. Shows a HUD message (localization key NotificationFoodLow) and play a sound (HudVocFoodLow). Cannot be smaller than 0 or larger than 1.
Damage <Damage>	Type: Single	Default: 7
Amount of damage dealt to character every 100 ticks while <DamageLevel> is below this stat's current value ratio. The damage type is Hunger. Cannot be smaller than 0 or larger than 100. Can be 0 to disable. No damage is dealt if world's FoodConsumptionRate is 0.
DamageLevel <DamageLevel>	Type: Single	Default: 0
The stat's ratio (1.0 is 100%) below which the character starts taking <Damage>. Cannot be smaller than 0 or larger than 1. No damage is dealt if world's FoodConsumptionRate is 0.
MovementSpeedDebuff <MovementSpeedDebuff>	Type: Single	Default: -0.01
Amount of character on-foot speed buff to give when below <CriticalLevel>. This value gets multiplied by 100 and by the difference between <CriticalLevel> and current stat's value ratio, then gets added to other character movement speed which is then used as a multiplier for all on-foot speeds. You have to use negative numbers for it to be a debuff. Cannot be smaller than -1 or larger than 1. Can be 0 to disable. Formula: ThisBuff = (CriticalLevel - CurrentRatio) * 100 * MovementSpeedDebuff OnFootSpeedMultiplier = World.CharacterSpeedMultiplier + MovementBuffStat + ThisBuff Ignored if world's FoodConsumptionRate is 0.
EnableSprintingOnCritical <EnableSprintingOnCritical>	Type: Boolean	Default: false
Toggles whether the character can sprint when this stat value ratio is below <CriticalLevel>. Ignored if world's FoodConsumptionRate is 0.

(Top) | From EntityStat Definition:

EnabledInCreative EnabledInCreative (attribute)	Type: Boolean	Default: True
Optional, whether this stat can be added in Creative game mode. Usage, on the opening element itself: <Stat xsi:type="MyObjectBuilder_EntityStatDefinition" EnabledInCreative="true"> The same can be decided for Survival game mode by using the <AvailableInSurvival> element.
Name <Name>	Type: String	Default: (empty)
The identifier for this stat per-character. Must be unique per-character but not globally. For example the game uses Health on multiple different stats, but each is used by a different character. Also used by things like ConsumableItem to mention this stat indirectly. The SubtypeId is still used to determine if the definition is intended to be overwritten so use a unique one there too.
MinValue <MinValue>	Type: Single	Default: 0
The stat's value cannot go lower than this. For things like health, this is the "character is dead" value.
MaxValue <MaxValue>	Type: Single	Default: 100
The stat's value cannot go higher than this.
DefaultValue <DefaultValue>	Type: Single	Default: NaN
The initial value of this stat. If undefined (left as Not-A-Number) then it will use the value of <MaxValue>.
ReducedOnSpawnValue <ReducedOnSpawnValue>	Type: Single	Default: 0
Optional. If larger than 0 and world's <EnableReducedStatsOnRespawn> is enabled, then this is the starting value for this stat when the character respawns at a medical room/survival kit. (Added in SE v1.207)

(Top) | From DefinitionBase:

Common

 ↑   🔗 

Id <Id>	Type: SerializableDefinitionId	Default: (invalid)
The type and subtype combined make up a unique identifier for this definition. If two definitions use the same Type+Subtype (Subtypes are only unique per Type), then the last to load will override the first one(s). For more details see Things to know about SBC. TypeId <TypeId> Type: string Default: (invalid) Must be an existing type with or without the "MyObjectBuilder_" prefix. Some types require an xsi:type, refer to the vanilla files for the exact pairing. TypeId vs xsi:type SubtypeId <SubtypeId> Type: string Default: (empty) This can be invented and only needs to be unique per TypeId. Vanilla game re-uses some subtypes over multiple types (e.g. Iron is used for Ore type and Ingot type). An empty value is also a valid subtype (which vanilla also uses on at least 5 blocks). Type Type (attribute) Type: string Default: (invalid) Same behavior as <TypeId>, do not define both. Subtype Subtype (attribute) Type: string Default: (empty) Same behavior as <SubtypeId>, do not define both. Example: <Id> <TypeId>CubeBlock</TypeId> <SubtypeId>FancyTable</SubtypeId> </Id> Because it has attribute alternatives it can also be declared as: <Id Type="CubeBlock" Subtype="FancyTable" />
DisplayName <DisplayName>	Type: String	Default: null
If the object defined here is visible anywhere in the game GUI, this would be the name shown for it. In cases where it is used, it is very much required. Can be plain-text. If the text contains DisplayName_ then: A localization key (from .resx files) will be searched for. It will scan for text variables to replace.
Description <Description>	Type: String	Default: null
Optional. If the object defined here is shown with a description in the game GUI (Hotbar/G-menu, HUD, etc) then this is the place to write it. Can be plain-text. If the text contains Description_ then: A localization key (from .resx files) will be searched for. It will scan for text variables to replace. If the final text (plain, localized or variable-replaced) contains {0}, {1}, etc, then they will replaced by kb&m control binds defined in <DescriptionArgs>.
DescriptionArgs <DescriptionArgs>	Type: String	Default: null
Optional. A comma-separated list of control IDs which are referenced in <Description> by {number} tags, which then get replaced by the keyboard or mouse bind that the viewer has for those controls. Example: <Description>Press {0} to fire, {1} to change color, {2} to interact.</description> <DescriptionArgs>PRIMARY_TOOL_ACTION,CUBE_COLOR_CHANGE,USE</DescriptionArgs> And each player will see their current binds for those actions. The control IDs can be found in your %appdata%/SpaceEngineers/SpaceEngineers.cfg at the ControlsButtons section.
Icon <Icon>	Type: String[]	Default: null
Icon(s) for the definition which may or may not be used depending on the definition type. Path to a .dds or .png file relative to current mod's folder. Falls back to game folder if not found in current mod. Referencing assets in other mods Can be declared multiple times which will stack icons on top of eachother, however it will not work for all definitions. Known definitions to work or not work with multiple icons Working: Blocks, BlockVariantGroups and component items seen in G-menu, BlockInfo (HUD right side) and toolbars; Blueprints in terminal production tab; Blocks and PhysicalItems in gamepad HUD. Partial: Blocks seen in terminal. Not working: HandItems (uses PhysicalItem's icon instead); Blocks and BlockVariantGroups seen in build planner, radial menu and some economy GUIs; PhysicalItems in economy GUIs and stores; Prefabs in stores; BlueprintClass (tabs) in terminal production tab; BankingSystemDefinition (Game\BankingSystem.sbc); Emotes (both kinds of definitions) in gamepad HUD; Block skins; RespawnShips. Special cases: Economy contracts, FactionIcons Definition.
DLC <DLC>	Type: String[]	Default: null
Optional. The DLC subtypeId that this definition will require. For the IDs, refer to <SE>\Content\Data\Game\DLCs.sbc. Can be declared multiple times to require multiple DLCs. Most definition types won't check for this, the ones that do: blocks, emotes and possibly anything else that can be placed in the toolbar.
AvailableInSurvival <AvailableInSurvival>	Type: Boolean	Default: true
Depends on the definition if it uses this, and if it does then this determines whether it can be accessible in survival game mode. Currently known definitions that do use this: Blocks, BlockVariantGroups, BlockCategories and any definition that can show up in a toolbar. EntityStatComponent Definition and EntityStat Definition.
Public <Public>	Type: Boolean	Default: true
If the definition is visible or accessible in some cases. For blocks, this only hides them and they can still be built using projectors and other means.
Enabled Enabled (attribute)	Type: Boolean	Default: true
If set to false it will remove the definition after it's been loaded. Example usage: <Definition Enabled="false"> The "Definition" above is the opening element that for the entire definition, not an inner node like <DisplayName> is. The opening node can have a different name for other definitions, some examples <Component>, <Blueprint>, etc.
xsi:type xsi:type (attribute)	Type: string	Default: null
Name of an object that this definition will be deserialized as. Sometimes required, depends on the definition. The wiki page for any given definition will mention at the top what xsi:type it requires, if any. The game's sbc files are also a reference on what xsi:types are required for a given definition. This attribute is available on all elements and comes from the XML specification. This game relies on this attribute to change which sub-definition object is used to deserialize that element's contents. It's what allows, for example, a thruster to have unique elements (such as <MinPlanetaryInfluence>) that no other block definitions have. For more details on how this relates to the TypeId, and usage examples, see: Things to know about SBC - TypeId vs xsi:type.

---