ORK Framework  2.27.1
API Documentation
ORKFramework.HUDClickAction Class Reference
Inheritance diagram for ORKFramework.HUDClickAction:
ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
void PlayAudio ()
 
bool CheckClick (Combatant combatant, float releasedAfter, ref bool clickConsumed)
 
- 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

HUDInfoClickType clickType = HUDInfoClickType.GlobalEvent
 
int globalEventID = 0
 
int callScreenID = 0
 
bool closeScreen = false
 
bool screenUseReq = false
 
int screenReqID = 0
 
HUDToggle [] hudToggle
 
float clickReleaseAfter = 0
 
bool clickConsume = true
 
AssetSource< AudioClip > clickClip = new AssetSource<AudioClip>()
 
float clickVolume = 1
 

Member Function Documentation

◆ SetData()

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

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

Parameters
dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.