ORK Framework  2.26.1
API Documentation
ORKFramework.BaseTypeData Class Reference

Default XML data serialization implementation. Descend your class from this class if no special XML data serialization is needed. More...

Inheritance diagram for ORKFramework.BaseTypeData:
ORKFramework.IBaseData ORKFramework.AccessHandler ORKFramework.BaseAssetSource< T > ORKFramework.Requirements.BaseStatusRequirementType ORKFramework.UI.BaseBattleMenuItem ORKFramework.UI.BaseHUDSetting ORKFramework.UI.BaseLootDialogueSettings ORKFramework.UI.GUIBaseLayoutSettings ORKFramework.Requirements.AbilityRequirementType ORKFramework.Requirements.ActionBarRequirementType ORKFramework.Requirements.ActivePlayerGroupRequirementType ORKFramework.Requirements.AIBehaviourRequirementType ORKFramework.Requirements.AIBehaviourSlotCountRequirementType ORKFramework.Requirements.AIRulesetRequirementType ORKFramework.Requirements.AIRulesetSlotCountRequirementType ORKFramework.Requirements.AITypeRequirementType ORKFramework.Requirements.ArmorItemTypeRequirementType ORKFramework.Requirements.ArmorRequirementType ORKFramework.Requirements.AttackAttributeRequirementType ORKFramework.Requirements.ClassRequirementType ORKFramework.Requirements.CombatantRequirementType ORKFramework.Requirements.CombatantTypeRequirementType ORKFramework.Requirements.DeathRequirementType ORKFramework.Requirements.DefenceAttributeRequirementType ORKFramework.Requirements.GridMoveRangeRequirementType ORKFramework.Requirements.GroupLeaderRequirementType ORKFramework.Requirements.GroupSizeRequirementType ORKFramework.Requirements.InActionRequirementType ORKFramework.Requirements.InBattleRequirementType ORKFramework.Requirements.InventoryRequirementType ORKFramework.Requirements.IsCastingRequirementType ORKFramework.Requirements.IsChoosingRequirementType ORKFramework.Requirements.IsResearchingRequirementType ORKFramework.Requirements.LevelRequirementType ORKFramework.Requirements.ResearchItemRequirementType ORKFramework.Requirements.ResearchTreeRequirementType ORKFramework.Requirements.StatusEffectRequirementType ORKFramework.Requirements.StatusEffectTypeRequirementType ORKFramework.Requirements.StatusValueRequirementType ORKFramework.Requirements.TurnStateRequirementType ORKFramework.Requirements.WeaponItemTypeRequirementType ORKFramework.Requirements.WeaponRequirementType ORKFramework.UI.AbilityBattleMenuItem ORKFramework.UI.AIBehaviourBattleMenuItem ORKFramework.UI.AIRulesetBattleMenuItem ORKFramework.UI.AttackBattleMenuItem ORKFramework.UI.AutoBattleMenuItem ORKFramework.UI.ChangeMemberBattleMenuItem ORKFramework.UI.ClassAbilityBattleMenuItem ORKFramework.UI.CommandBattleMenuItem ORKFramework.UI.DefendBattleMenuItem ORKFramework.UI.EndBattleMenuItem ORKFramework.UI.EquipmentBattleMenuItem ORKFramework.UI.EscapeBattleMenuItem ORKFramework.UI.GridExamineBattleMenuItem ORKFramework.UI.GridMoveBattleMenuItem ORKFramework.UI.GridOrientationBattleMenuItem ORKFramework.UI.ItemBattleMenuItem ORKFramework.UI.ShortcutSlotBattleMenuItem ORKFramework.UI.CombatantHUDSetting ORKFramework.UI.ConsoleHUDSetting ORKFramework.UI.ControlHUDSetting ORKFramework.UI.InformationHUDSetting ORKFramework.UI.InteractionHUDSetting ORKFramework.UI.LatestTurnHUDSetting ORKFramework.UI.NavigationHUDSetting ORKFramework.UI.QuestHUDSetting ORKFramework.UI.TimebarHUDSetting ORKFramework.UI.TooltipHUDSetting ORKFramework.UI.TurnOrderHUDSetting ORKFramework.UI.LayoutScreenLootDialogueSettings ORKFramework.UI.SimpleLootDialogueSettings ORKFramework.UI.GUICircleLayoutSettings ORKFramework.UI.GUIColumnLayoutSettings ORKFramework.UI.GUIGridLayoutSettings ORKFramework.UI.GUIListLayoutSettings ORKFramework.UI.GUIOffsetLayoutSettings ORKFramework.UI.GUIRowLayoutSettings

Public Member Functions

virtual DataObject GetData ()
 Gets a ORKFramework.DataObject representing the class. More...
 
virtual void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...
 
virtual bool IsType (string type)
 Checks if the setting is of a defindd type. More...
 

Protected Member Functions

virtual string GetTypeNamespace ()
 

Detailed Description

Default XML data serialization implementation. Descend your class from this class if no special XML data serialization is needed.

Member Function Documentation

◆ EditorAutoSetup()

virtual void ORKFramework.BaseTypeData.EditorAutoSetup ( string  fieldName)
virtual

Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute.

Parameters
fieldNameThe name of the field the function is called for.

Implements ORKFramework.IBaseData.

◆ GetData()

virtual DataObject ORKFramework.BaseTypeData.GetData ( )
virtual

Gets a ORKFramework.DataObject representing the class.

Returns
ORKFramework.DataObject containing the class data.

Implements ORKFramework.IBaseData.

◆ IsType()

virtual bool ORKFramework.BaseTypeData.IsType ( string  type)
virtual

Checks if the setting is of a defindd type.

Parameters
typeThe class type of string, consisting of namespace and class name.
Returns
true if the type matches.

◆ SetData()

virtual void ORKFramework.BaseTypeData.SetData ( DataObject  data)
virtual

Sets the variables of the class using a ORKFramework.DataObject.

Parameters
dataORKFramework.DataObject containing the data.

Implements ORKFramework.IBaseData.

Reimplemented in ORKFramework.UI.TooltipHUDSetting, ORKFramework.UI.CombatantHUDSetting, ORKFramework.UI.TurnOrderHUDSetting, ORKFramework.UI.ConsoleHUDSetting, ORKFramework.UI.InteractionHUDSetting, ORKFramework.UI.NavigationHUDSetting, ORKFramework.UI.InformationHUDSetting, ORKFramework.UI.AIBehaviourBattleMenuItem, ORKFramework.UI.AIRulesetBattleMenuItem, ORKFramework.UI.QuestHUDSetting, ORKFramework.UI.SimpleLootDialogueSettings, ORKFramework.UI.ControlHUDSetting, ORKFramework.Requirements.StatusValueRequirementType, ORKFramework.Requirements.ResearchItemRequirementType, ORKFramework.Requirements.DefenceAttributeRequirementType, ORKFramework.Requirements.AbilityRequirementType, ORKFramework.Requirements.ArmorRequirementType, ORKFramework.Requirements.StatusEffectRequirementType, ORKFramework.Requirements.WeaponRequirementType, ORKFramework.Requirements.AttackAttributeRequirementType, ORKFramework.Requirements.CombatantRequirementType, ORKFramework.Requirements.ArmorItemTypeRequirementType, ORKFramework.Requirements.WeaponItemTypeRequirementType, ORKFramework.UI.AutoBattleMenuItem, ORKFramework.Requirements.GroupSizeRequirementType, ORKFramework.Requirements.ResearchTreeRequirementType, ORKFramework.Requirements.TurnStateRequirementType, ORKFramework.Requirements.AIBehaviourRequirementType, ORKFramework.Requirements.AIRulesetRequirementType, ORKFramework.Requirements.AITypeRequirementType, ORKFramework.Requirements.ClassRequirementType, ORKFramework.Requirements.CombatantTypeRequirementType, ORKFramework.Requirements.StatusEffectTypeRequirementType, ORKFramework.Requirements.AIBehaviourSlotCountRequirementType, and ORKFramework.Requirements.AIRulesetSlotCountRequirementType.