ORK Framework  2.27.1
API Documentation
ORKFramework.GridExamineBestiaryChoice Class Reference
Inheritance diagram for ORKFramework.GridExamineBestiaryChoice:
ORKFramework.BestiaryChoice ORKFramework.BaseData ORKFramework.IChoice ORKFramework.IBaseData ORKFramework.IChoiceSimple

Public Member Functions

override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
override void Show (Combatant combatant, bool isAcceptDialogue, bool canCancel, NotifyBool callback, NotifyCheck customTick)
 
override void Close ()
 
override void Closed (GUIBox origin)
 
bool CheckCall ()
 
bool CheckCloseCall (Combatant combatant)
 
bool CheckShow (Combatant user, Combatant combatant)
 
void PlayOpenAudio ()
 
void PlayCloseAudio ()
 
void UseControlBlocks (int change)
 
override void Canceled (GUIBox origin)
 
- Public Member Functions inherited from ORKFramework.BestiaryChoice
bool Tick (GUIBox origin)
 
bool UnfocusedTick (GUIBox origin)
 
bool NotControlableTick (GUIBox origin)
 
bool ShowOKButton (GUIBox origin)
 
bool ShowCancelButton (GUIBox origin)
 
bool IsOKButtonActive (GUIBox origin)
 
bool IsCancelButtonActive (GUIBox origin)
 
void Show ()
 
void FocusGained (GUIBox origin)
 
void FocusLost (GUIBox origin)
 
void OutOfBoxClick (GUIBox origin)
 
void ChoiceSelected (int index, GUIBox origin)
 
void SelectionChanged (int index, GUIBox origin)
 
- 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

bool showForPlayer = true
 
bool showForAllies = true
 
bool showForEnemies = true
 
bool autoShow = false
 
bool useCallKey = false
 
int callKey = 0
 
bool callCursorOver = false
 
bool closeOn2nd = false
 
bool closeOn2ndSameCombatant = true
 
bool blockPlayerControl = false
 
bool blockCameraControl = false
 
AssetSource< AudioClip > openAudio = new AssetSource<AudioClip>()
 
float openVolume = 1.0f
 
AssetSource< AudioClip > closeAudio = new AssetSource<AudioClip>()
 
float closeVolume = 1.0f
 
bool useUser = false
 
bool hideForUser = false
 
- Public Attributes inherited from ORKFramework.BestiaryChoice
int guiBoxID = 0
 
bool uiHidesBox = false
 
bool showOkButton = false
 
bool showCancelButton = false
 
bool useBestiaryInfo = true
 
bool atCombatantObject = false
 
string childName = ""
 
Vector2 positionOffset = Vector2.zero
 
bool showPortrait = false
 
int portraitType = 0
 
BaseCombatantInformationDisplay entryInfo = new BaseCombatantInformationDisplay()
 

Protected Member Functions

override bool CheckTick (GUIBox origin)
 
- Protected Member Functions inherited from ORKFramework.BestiaryChoice
void ChangeEntryPage (int change)
 

Additional Inherited Members

- Protected Attributes inherited from ORKFramework.BestiaryChoice
GUIBox box
 
int current = 0
 
Combatant combatant
 
bool isAcceptDialogue = false
 
bool canCancel = true
 
bool canceled = false
 
NotifyBool callback
 
NotifyCheck customTick
 
- Properties inherited from ORKFramework.BestiaryChoice
Combatant Combatant [get]
 
bool IsOpen [get]
 

Member Function Documentation

◆ SetData()

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

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

Parameters
dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.