SCR_BaseAttributeDynamicDescription Interface Reference

Holds logic when a dynamic description should be shown when attributes are hovered over. More...

Inheritance diagram for SCR_BaseAttributeDynamicDescription:

Public Member Functions
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
ref SCR_EditorAttributeUIInfo	m_DescriptionDisplayInfo
bool	m_bEnabled

Detailed Description

Holds logic when a dynamic description should be shown when attributes are hovered over.

Do not use base class

Member Function Documentation

GetDescriptionData()

void SCR_BaseAttributeDynamicDescription.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

	attribute	Attribute linked to the desciption
[out]	uiInfo	UiInfo with icon, description and color to display the description
[out]	param1	Optional param 1 to add to the description
[out]	param2	Optional param 2 to add to the description
[out]	param3	Optional param 3 to add to the description

Implemented in SCR_ArsenalSaveTypeAttributeDynamicDescription, SCR_DateAttributeDynamicDescription, SCR_DayDurationAttributeDynamicDescription, SCR_GameOverTypeAttributeDynamicDescription, and SCR_PlayableFactionKillingAttributeDynamicDescription.

InitDynamicDescription()

void SCR_BaseAttributeDynamicDescription.InitDynamicDescription	(	notnull SCR_BaseEditorAttribute	attribute,
		notnull SCR_BaseEditorAttributeUIComponent	attributeUi )

Init the dynamic description.

Parameters

attribute

Attribute linked to the desciption

Implemented in SCR_ArsenalSaveTypeAttributeDynamicDescription, SCR_BoolAttributeDynamicDescription, SCR_CharacterBloodAttributeDynamicDescription, SCR_DateAttributeDynamicDescription, SCR_DayDurationAttributeDynamicDescription, SCR_GameOverTypeAttributeDynamicDescription, SCR_LoadoutSavingBlackListAttributeDynamicDescription, SCR_PlayableFactionKillingAttributeDynamicDescription, and SCR_ValueAttributeDynamicDescription.

IsValid()

bool SCR_BaseAttributeDynamicDescription.IsValid	(	notnull SCR_BaseEditorAttribute	attribute,
		notnull SCR_BaseEditorAttributeUIComponent	attributeUi )

Check if conditions are valid to display the Dynamic description.

Parameters

attribute

Attribute linked to the desciption

Returns

true if valid

Implemented in SCR_ArsenalSaveTypeAttributeDynamicDescription, SCR_BasicDisabledAttributeDynamicDescription, SCR_BoolAttributeDynamicDescription, SCR_CharacterBloodAttributeDynamicDescription, SCR_DateAttributeDynamicDescription, SCR_DayDurationAttributeDynamicDescription, SCR_GameOverTypeAttributeDynamicDescription, SCR_LoadoutSavingBlackListAttributeDynamicDescription, SCR_PlayableFactionKillingAttributeDynamicDescription, and SCR_ValueAttributeDynamicDescription.

Member Data Documentation

m_bEnabled

bool SCR_BaseAttributeDynamicDescription.m_bEnabled

protected

m_DescriptionDisplayInfo

ref SCR_EditorAttributeUIInfo SCR_BaseAttributeDynamicDescription.m_DescriptionDisplayInfo

protected

---

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

• Game/Editor/Containers/Attributes/DynamicDescriptions/SCR_BaseAttributeDynamicDescription.c