Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
SCR_ValueAttributeDynamicDescription Interface Reference

Shows dynamic description if value meets the condition. More...

Inheritance diagram for SCR_ValueAttributeDynamicDescription:
[legend]

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.
 
- Public Member Functions inherited from SCR_BaseAttributeDynamicDescription
void InitDynamicDescription (notnull SCR_BaseEditorAttribute attribute, notnull SCR_BaseEditorAttributeUIComponent attributeUi)
 Init the dynamic description.
 
bool IsValid (notnull SCR_BaseEditorAttribute attribute, notnull SCR_BaseEditorAttributeUIComponent attributeUi)
 Check if conditions are valid to display the Dynamic description.
 
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.
 

Protected Attributes

EAttributeValueDynamicDescription m_eDisplayIfValue
 
float m_fValueCondition
 
bool m_bOnlyShowIfConditionChanged
 
float m_fStartingValue
 
- Protected Attributes inherited from SCR_BaseAttributeDynamicDescription
ref SCR_EditorAttributeUIInfo m_DescriptionDisplayInfo
 
bool m_bEnabled
 

Detailed Description

Shows dynamic description if value meets the condition.

Member Function Documentation

◆ InitDynamicDescription()

override void SCR_ValueAttributeDynamicDescription.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_ValueAttributeDynamicDescription.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.

Member Data Documentation

◆ m_bOnlyShowIfConditionChanged

bool SCR_ValueAttributeDynamicDescription.m_bOnlyShowIfConditionChanged
protected

◆ m_eDisplayIfValue

EAttributeValueDynamicDescription SCR_ValueAttributeDynamicDescription.m_eDisplayIfValue
protected

◆ m_fStartingValue

float SCR_ValueAttributeDynamicDescription.m_fStartingValue
protected

◆ m_fValueCondition

float SCR_ValueAttributeDynamicDescription.m_fValueCondition
protected

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