ORK Framework  2.24.0
API Documentation
ORKFramework.HUDSetting Class Reference
Inheritance diagram for ORKFramework.HUDSetting:
ORKFramework.BaseIndexData ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

 HUDSetting (string n)
 
override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
override void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...
 
void SetInitialToggleState ()
 
void CheckToggleKey ()
 
- Public Member Functions inherited from ORKFramework.BaseData
virtual DataObject GetData ()
 Gets a ORKFramework.DataObject representing the class. More...
 

Public Attributes

string name = ""
 
int guiBoxID = 0
 
HUDType type = HUDType.Information
 
bool noDisplay = false
 
ToggleKeySetting toggleKey = new ToggleKeySetting()
 
BaseHUDSetting settings = new InformationHUDSetting()
 

Properties

bool Blocked [get, set]
 
bool Toggle [get, set]
 
- Properties inherited from ORKFramework.BaseIndexData
virtual int RealID [get, set]
 

Additional Inherited Members

- Protected Attributes inherited from ORKFramework.BaseIndexData
int realID = 0
 

Member Function Documentation

override void ORKFramework.HUDSetting.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.

Reimplemented from ORKFramework.BaseData.

override void ORKFramework.HUDSetting.SetData ( DataObject  data)
virtual

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

Parameters
dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.