SCR_DateAttributeDynamicDescription Interface Reference

Dynamic description for SCR_DateEditorAttribute to show sunrise, sunset and moonphase. More...

Inheritance diagram for SCR_DateAttributeDynamicDescription:

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.

Protected Attributes
string	m_sNoSunriseSunSet
TimeAndWeatherManagerEntity	m_TimeAndWeatherManager
SCR_AttributesManagerEditorComponent	m_AttributeManager
Protected Attributes inherited from SCR_BaseAttributeDynamicDescription
ref SCR_EditorAttributeUIInfo	m_DescriptionDisplayInfo
bool	m_bEnabled

Detailed Description

Dynamic description for SCR_DateEditorAttribute to show sunrise, sunset and moonphase.

Member Function Documentation

GetDescriptionData()

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

InitDynamicDescription()

override void SCR_DateAttributeDynamicDescription.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_DateAttributeDynamicDescription.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.

Member Data Documentation

m_AttributeManager

SCR_AttributesManagerEditorComponent SCR_DateAttributeDynamicDescription.m_AttributeManager

protected

m_sNoSunriseSunSet

string SCR_DateAttributeDynamicDescription.m_sNoSunriseSunSet

protected

m_TimeAndWeatherManager

TimeAndWeatherManagerEntity SCR_DateAttributeDynamicDescription.m_TimeAndWeatherManager

protected

---

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

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