ORK Framework  2.22.0
API Documentation
ORKFramework.BattleMenu Class Reference
Inheritance diagram for ORKFramework.BattleMenu:
ORKFramework.BaseIndexData ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

 BattleMenu (string name)
 
override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
void AddBack (List< BMItem > list)
 
List< BMItemGetMenu (Combatant owner)
 
string GetDescriptionTitle ()
 
int GetGUIBoxID (BattleMenuMode mode)
 
HeaderContent GetHeaderContent (BattleMenuMode mode)
 
- Public Member Functions inherited from ORKFramework.BaseData
virtual DataObject GetData ()
 Gets a ORKFramework.DataObject representing the class. More...
 
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...
 

Public Attributes

string name = ""
 
int guiBoxID = 0
 
float updateInterval = 0.5f
 
bool setTimeScale = false
 
bool setORKScale = false
 
float timeScale = 1
 
bool useSubBoxes = false
 
int abilityTypeBoxID = 0
 
int abilityBoxID = 0
 
int itemTypeBoxID = 0
 
int itemBoxID = 0
 
int targetBoxID = 0
 
int equipmentPartBoxID = 0
 
int equipmentBoxID = 0
 
int commandBoxID = 0
 
bool showTitle = true
 
string[] title = ArrayHelper.CreateArray(ORK.Languages.Count, "%n")
 
bool selectLastTarget = false
 
bool selectSelf = false
 
bool rememberSelection = false
 
bool resetSelection = false
 
bool useGroupTarget = false
 
bool useIndividualTarget = false
 
AddBackButton backButton = new AddBackButton()
 
bool backInBase = false
 
AudioClip openClip
 
float openVolume = 1
 
AudioClip closeClip
 
float closeVolume = 1
 
ContentLayout contentLayout = new ContentLayout(ContentLayoutType.Both, ContentLayoutInfoType.Info)
 
bool useDesc = false
 
int descBoxID = 0
 
bool descAlways = false
 
bool useDescTitle = false
 
string[] descTitle
 
bool showPortrait = false
 
int portraitTypeID = 0
 
bool ownPortraitPosition = false
 
PortraitPosition portraitPosition
 
bool showItemPortraits = false
 
int itemPortraitTypeID = 0
 
bool showEquipPortraits = false
 
int equipPortraitTypeID = 0
 
bool showAIBehaviourPortraits = false
 
int aiBehaviourPortraitTypeID = 0
 
bool showAIRulesetPortraits = false
 
int aiRulesetPortraitTypeID = 0
 
bool showAbilityPortraits = false
 
int abilityPortraitTypeID = 0
 
bool showTargetPortraits = false
 
int targetPortraitTypeID = 0
 
bool showCommandPortraits = false
 
int commandPortraitTypeID = 0
 
bool showChangePortraits = false
 
int changePortraitTypeID = 0
 
bool ownCombatantChoice = false
 
CombatantChoiceLayout combatantChoice
 
HeaderTexts headerTexts = new HeaderTexts()
 
bool useSubHeaders = false
 
HeaderTexts abilityTypeHeaderTexts
 
HeaderTexts abilityHeaderTexts
 
HeaderTexts itemTypeHeaderTexts
 
HeaderTexts itemHeaderTexts
 
HeaderTexts targetHeaderTexts
 
TitleHeaderTexts equipPartHeaderTexts
 
HeaderTexts equipHeaderTexts
 
HeaderTexts commandHeaderTexts
 
HighlightGameObjectSetting userHighlight = new HighlightGameObjectSetting()
 
BattleMenuItem[] item = new BattleMenuItem[] {new BattleMenuItem()}
 

Additional Inherited Members

- Protected Attributes inherited from ORKFramework.BaseIndexData
int realID = 0
 
- Properties inherited from ORKFramework.BaseIndexData
virtual int RealID [get, set]
 

Member Function Documentation

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

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

Parameters
dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.