ORK Framework  2.25.2
API Documentation
ORKFramework.HUDControl Class Reference
Inheritance diagram for ORKFramework.HUDControl:
ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
void PlayClip ()
 
void Close ()
 
void Tick (ControlHUDContent hudContent, int index)
 
void Show ()
 
void CreateObjects (GUIBox guiBox, GameObject parent)
 
- 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

HUDControlType type = HUDControlType.PositiveButton
 
int keyID = 0
 
ColumnFill axisType = ColumnFill.Horizontal
 
bool invertAxis = false
 
int keyID2 = 0
 
bool invertAxis2 = false
 
Vector2 axisCenter = Vector2.zero
 
float maxDist = 50
 
bool autoRelease = false
 
float releaseDist = 200
 
bool autoRelB = false
 
AssetSource< AudioClip > audioClip
 
float volume = 1
 
BaseImage image = new BaseImage()
 
Rect imgBounds = new Rect(0, 0, 100, 100)
 
bool usePressed = false
 
BaseImage pressedImage
 
Rect pImgBounds = new Rect(0, 0, 100, 100)
 
float pTime = 0
 
bool box = false
 
bool noFlash = false
 
Rect bounds = new Rect(0, 0, 300, 100)
 
bool showBackground = false
 
DisplayImage bg
 

Properties

bool IsPressed [get]
 
Vector2 PositionOffset [get]
 

Member Function Documentation

◆ SetData()

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

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

Parameters
dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.