Barotrauma Client
Loading...
Searching...
No Matches
Barotrauma.Serialize Class Referencesealed
Inheritance diagram for Barotrauma.Serialize:

Public Member Functions

 Serialize (object defaultValue, IsPropertySaveable isSaveable, string description="", string translationTextTag="", bool alwaysUseInstanceValues=false)
 Makes the property serializable to/from XML.
 

Public Attributes

readonly object DefaultValue
 
readonly IsPropertySaveable IsSaveable
 
readonly Identifier TranslationTextTag
 
bool AlwaysUseInstanceValues
 If set to true, the instance values saved in a submarine file will always override the prefab values, even if using a mod that normally overrides instance values.
 
string Description
 

Constructor & Destructor Documentation

◆ Serialize()

Barotrauma.Serialize.Serialize ( object defaultValue,
IsPropertySaveable isSaveable,
string description = "",
string translationTextTag = "",
bool alwaysUseInstanceValues = false )

Makes the property serializable to/from XML.

Parameters
defaultValueThe property is set to this value during deserialization if the value is not defined in XML.
isSaveableIs the value saved to XML when serializing.
translationTextTagIf set to anything else than null, SerializableEntityEditors will show what the text gets translated to or warn if the text is not found in the language files.
Parameters
alwaysUseInstanceValuesIf set to true, the instance values saved in a submarine file will always override the prefab values, even if using a mod that normally overrides instance values. Setting the value to a non-empty string will let the user select the text from one whose tag starts with the given string (e.g. RoomName. would show all texts with a RoomName.* tag)

Member Data Documentation

◆ AlwaysUseInstanceValues

bool Barotrauma.Serialize.AlwaysUseInstanceValues

If set to true, the instance values saved in a submarine file will always override the prefab values, even if using a mod that normally overrides instance values.

◆ DefaultValue

readonly object Barotrauma.Serialize.DefaultValue

◆ Description

string Barotrauma.Serialize.Description

◆ IsSaveable

readonly IsPropertySaveable Barotrauma.Serialize.IsSaveable

◆ TranslationTextTag

readonly Identifier Barotrauma.Serialize.TranslationTextTag

The documentation for this class was generated from the following file: