SCR_PlayableFactionKillingAttributeDynamicDescription Interface Reference

Dynamic description for SCR_PlayableFactionEditorAttribute and SCR_PlayableFactionsEditorAttribute to show how many players are killed. More...

Inheritance diagram for SCR_PlayableFactionKillingAttributeDynamicDescription:

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.
Public Member Functions inherited from SCR_BaseButtonAttributeDynamicDescription
bool	HasPriorityOverButton ()
	Return true if has priority over button descriptions.
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 Member Functions
void	UpdateTotalToBeKilledPlayers (SCR_BaseEditorAttribute attribute)
void	GetDisabledFactions (SCR_BaseEditorAttribute attribute, notnull out array< int > disabledFactions)

Protected Attributes
int	m_iPlayersWillBeKilled = 0
ref array< int >	m_aStartingDisabledFactions = {}
FactionManager	m_FactionManager
SCR_ToolboxComponent	m_ToolBoxComponent
SCR_BaseEditorAttributeFloatStringValues	m_ButtonBoxData
SCR_RespawnSystemComponent	m_RespawnSystemComponent
SCR_PlayerDelegateEditorComponent	m_PlayerDelegateManager
Protected Attributes inherited from SCR_BaseButtonAttributeDynamicDescription
bool	m_bPriorityOverButtonDescription
Protected Attributes inherited from SCR_BaseAttributeDynamicDescription
ref SCR_EditorAttributeUIInfo	m_DescriptionDisplayInfo
bool	m_bEnabled

Detailed Description

Dynamic description for SCR_PlayableFactionEditorAttribute and SCR_PlayableFactionsEditorAttribute to show how many players are killed.

Member Function Documentation

GetDescriptionData()

override void SCR_PlayableFactionKillingAttributeDynamicDescription.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

Implements SCR_BaseAttributeDynamicDescription.

GetDisabledFactions()

void SCR_PlayableFactionKillingAttributeDynamicDescription.GetDisabledFactions ( SCR_BaseEditorAttribute  attribute, notnull out array< int >  disabledFactions  )

protected

InitDynamicDescription()

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

Init the dynamic description.

Parameters

attribute

Attribute linked to the desciption

Implements SCR_BaseAttributeDynamicDescription.

IsValid()

override bool SCR_PlayableFactionKillingAttributeDynamicDescription.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

Implements SCR_BaseAttributeDynamicDescription.

UpdateTotalToBeKilledPlayers()

void SCR_PlayableFactionKillingAttributeDynamicDescription.UpdateTotalToBeKilledPlayers ( SCR_BaseEditorAttribute  attribute )

protected

Member Data Documentation

m_aStartingDisabledFactions

ref array<int> SCR_PlayableFactionKillingAttributeDynamicDescription.m_aStartingDisabledFactions = {}

protected

m_ButtonBoxData

SCR_BaseEditorAttributeFloatStringValues SCR_PlayableFactionKillingAttributeDynamicDescription.m_ButtonBoxData

protected

m_FactionManager

FactionManager SCR_PlayableFactionKillingAttributeDynamicDescription.m_FactionManager

protected

m_iPlayersWillBeKilled

int SCR_PlayableFactionKillingAttributeDynamicDescription.m_iPlayersWillBeKilled = 0

protected

m_PlayerDelegateManager

SCR_PlayerDelegateEditorComponent SCR_PlayableFactionKillingAttributeDynamicDescription.m_PlayerDelegateManager

protected

m_RespawnSystemComponent

SCR_RespawnSystemComponent SCR_PlayableFactionKillingAttributeDynamicDescription.m_RespawnSystemComponent

protected

m_ToolBoxComponent

SCR_ToolboxComponent SCR_PlayableFactionKillingAttributeDynamicDescription.m_ToolBoxComponent

protected

---

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

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