Makinom  1.16.0
API Documentation
Makinom.UI.BaseHUDSetting Class Referenceabstract
Inheritance diagram for Makinom.UI.BaseHUDSetting:
Makinom.BaseTypeData Makinom.IBaseData Makinom.UI.ControlHUDSetting Makinom.UI.InformationHUDSetting Makinom.UI.InteractionHUDSetting Makinom.UI.TooltipHUDSetting

Public Member Functions

abstract GUIBoxContent Create (HUDSetting hud)
 Creates an instance of a GUIBoxContent class to display the HUD in a GUI box. More...
 
virtual void Register (HUD hud)
 Handles registering to update/change events. More...
 
virtual void Unregister (HUD hud)
 Handles unregistering from update/change events. More...
 
virtual void TickVisible (HUD hud, DataCall call)
 Update per frame when the HUD is visible. More...
 
virtual void TickInvisible (HUD hud, DataCall call)
 Update per frame when the HUD is not visible. More...
 
virtual void PlayerChanged (HUD hud)
 Called when the player changed. More...
 
virtual void GlobalSelectedDataChanged (HUD hud)
 Called when the global selected data changed. More...
 
abstract bool IsVisible (HUD instance, DataCall call)
 Checks if the HUD is visible. Implement your custom visibility condition checks here. More...
 
virtual GUIBaseLayout GetLayout ()
 
virtual void SetBoxOffset (HUD hud, int index, GUIBox box, GUIBox previousBox, GameObject user)
 Sets the offset between GUI boxes for multiple users. More...
 
virtual void CheckCursorOver (HUD hud)
 Implement checks for only displaying the HUD when the cursor is over e.g. the game object of the user. More...
 
virtual void EditorCheck ()
 
virtual void EditorTypeChangeCheck ()
 
- Public Member Functions inherited from Makinom.BaseTypeData
virtual DataObject GetData ()
 Gets a Makinom.DataObject representing the class. More...
 
virtual void SetData (DataObject data)
 Sets the variables of the class using a Makinom.DataObject. More...
 
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the Makinom.EditorLayoutAttribute. More...
 
virtual bool IsType (string type)
 Checks if the setting is of a defindd type. More...
 

Properties

abstract BaseHUDElement [] Elements [get]
 The HUD elements of this HUD. More...
 
abstract HUDImageSettings Image [get]
 The HUDImageSettings of this HUD. More...
 
abstract bool EmptyElements [get]
 true if this HUD displays empty HUD elements. More...
 
virtual bool AddBoxNoUser [get]
 true if this HUD is displayed when all users have been removed. More...
 
virtual bool UpdateUsers [get]
 true if the HUD users will be updated. More...
 

Member Function Documentation

◆ CheckCursorOver()

virtual void Makinom.UI.BaseHUDSetting.CheckCursorOver ( HUD  hud)
virtual

Implement checks for only displaying the HUD when the cursor is over e.g. the game object of the user.

Parameters
hudThe instance of the HUD.

Reimplemented in Makinom.UI.InformationHUDSetting.

◆ Create()

abstract GUIBoxContent Makinom.UI.BaseHUDSetting.Create ( HUDSetting  hud)
pure virtual

Creates an instance of a GUIBoxContent class to display the HUD in a GUI box.

Parameters
hudThe parent HUDSetting class.
Returns
An instance of a GUIBoxContent class that will be used by a GUI box to display the HUD.

Implemented in Makinom.UI.InformationHUDSetting, Makinom.UI.InteractionHUDSetting, Makinom.UI.TooltipHUDSetting, and Makinom.UI.ControlHUDSetting.

◆ GlobalSelectedDataChanged()

virtual void Makinom.UI.BaseHUDSetting.GlobalSelectedDataChanged ( HUD  hud)
virtual

Called when the global selected data changed.

Parameters
hudThe instance of the HUD.

Reimplemented in Makinom.UI.InformationHUDSetting.

◆ IsVisible()

abstract bool Makinom.UI.BaseHUDSetting.IsVisible ( HUD  instance,
DataCall  call 
)
pure virtual

Checks if the HUD is visible. Implement your custom visibility condition checks here.

Parameters
instanceThe instance of the HUD.
callThe DataCall used for values/calculations.
Returns
true when the HUD is visible.

Implemented in Makinom.UI.InformationHUDSetting, Makinom.UI.InteractionHUDSetting, Makinom.UI.TooltipHUDSetting, and Makinom.UI.ControlHUDSetting.

◆ PlayerChanged()

virtual void Makinom.UI.BaseHUDSetting.PlayerChanged ( HUD  hud)
virtual

Called when the player changed.

Parameters
hudThe instance of the HUD.

Reimplemented in Makinom.UI.InformationHUDSetting.

◆ Register()

virtual void Makinom.UI.BaseHUDSetting.Register ( HUD  hud)
virtual

Handles registering to update/change events.

Parameters
hudThe instande of the HUD.

Reimplemented in Makinom.UI.InformationHUDSetting.

◆ SetBoxOffset()

virtual void Makinom.UI.BaseHUDSetting.SetBoxOffset ( HUD  hud,
int  index,
GUIBox  box,
GUIBox  previousBox,
GameObject  user 
)
virtual

Sets the offset between GUI boxes for multiple users.

Parameters
hudThe instance of the HUD.
indexThe index of the box
boxThe GUIBox the offset is set for.
previousBoxThe previous GUIBox. Can be null.
userThe user's game object.

Reimplemented in Makinom.UI.InformationHUDSetting.

◆ TickInvisible()

virtual void Makinom.UI.BaseHUDSetting.TickInvisible ( HUD  hud,
DataCall  call 
)
virtual

Update per frame when the HUD is not visible.

Parameters
hudThe instance of the HUD.
callThe DataCall used for values/calculations.

◆ TickVisible()

virtual void Makinom.UI.BaseHUDSetting.TickVisible ( HUD  hud,
DataCall  call 
)
virtual

Update per frame when the HUD is visible.

Parameters
hudThe instance of the HUD.
callThe DataCall used for values/calculations.

Reimplemented in Makinom.UI.InformationHUDSetting, and Makinom.UI.ControlHUDSetting.

◆ Unregister()

virtual void Makinom.UI.BaseHUDSetting.Unregister ( HUD  hud)
virtual

Handles unregistering from update/change events.

Parameters
hudThe instande of the HUD.

Reimplemented in Makinom.UI.InformationHUDSetting.

Property Documentation

◆ AddBoxNoUser

virtual bool Makinom.UI.BaseHUDSetting.AddBoxNoUser
get

true if this HUD is displayed when all users have been removed.

◆ Elements

abstract BaseHUDElement [] Makinom.UI.BaseHUDSetting.Elements
get

The HUD elements of this HUD.

◆ EmptyElements

abstract bool Makinom.UI.BaseHUDSetting.EmptyElements
get

true if this HUD displays empty HUD elements.

◆ Image

abstract HUDImageSettings Makinom.UI.BaseHUDSetting.Image
get

The HUDImageSettings of this HUD.

◆ UpdateUsers

virtual bool Makinom.UI.BaseHUDSetting.UpdateUsers
get

true if the HUD users will be updated.