Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_DayDurationAttributeDynamicDescription Interface Reference

Dynamic description for daytime duration to display to compare the ingame time with realife time. More...

Inheritance diagram for SCR_DayDurationAttributeDynamicDescription:
SCR_BaseAttributeDynamicDescription

Public Member Functions

override void InitDynamicDescription (notnull SCR_BaseEditorAttribute attribute, notnull SCR_BaseEditorAttributeUIComponent attributeUi)
 Init the dynamic description.
 
override bool IsValid (notnull SCR_BaseEditorAttribute attribute, notnull SCR_BaseEditorAttributeUIComponent attributeUi)
 Check if conditions are valid to display the Dynamic description.
 
override void GetDescriptionData (notnull SCR_BaseEditorAttribute attribute, notnull SCR_BaseEditorAttributeUIComponent attributeUi, out SCR_EditorAttributeUIInfo uiInfo, out string param1=string.Empty, out string param2=string.Empty, out string param3=string.Empty)
 Init the dynamic description.
 

Additional Inherited Members

- Protected Attributes inherited from SCR_BaseAttributeDynamicDescription
ref SCR_EditorAttributeUIInfo m_DescriptionDisplayInfo
 
bool m_bEnabled
 

Detailed Description

Dynamic description for daytime duration to display to compare the ingame time with realife time.

Member Function Documentation

◆ GetDescriptionData()

override void SCR_DayDurationAttributeDynamicDescription.GetDescriptionData ( notnull SCR_BaseEditorAttribute attribute,
notnull SCR_BaseEditorAttributeUIComponent attributeUi,
out SCR_EditorAttributeUIInfo uiInfo,
out string param1 = string::Empty,
out string param2 = string::Empty,
out string param3 = string::Empty )

Init the dynamic description.

Parameters
attributeAttribute linked to the desciption
[out]uiInfoUiInfo with icon, description and color to display the description
[out]param1Optional param 1 to add to the description
[out]param2Optional param 2 to add to the description
[out]param3Optional param 3 to add to the description

Implements SCR_BaseAttributeDynamicDescription.

◆ InitDynamicDescription()

override void SCR_DayDurationAttributeDynamicDescription.InitDynamicDescription ( notnull SCR_BaseEditorAttribute attribute,
notnull SCR_BaseEditorAttributeUIComponent attributeUi )

Init the dynamic description.

Parameters
attributeAttribute linked to the desciption

Implements SCR_BaseAttributeDynamicDescription.

◆ IsValid()

override bool SCR_DayDurationAttributeDynamicDescription.IsValid ( notnull SCR_BaseEditorAttribute attribute,
notnull SCR_BaseEditorAttributeUIComponent attributeUi )

Check if conditions are valid to display the Dynamic description.

Parameters
attributeAttribute linked to the desciption
Returns
true if valid

Implements SCR_BaseAttributeDynamicDescription.


The documentation for this interface was generated from the following file: