Inheritance diagram for SCR_DateEditorAttribute:

Public Member Functions
override SCR_BaseEditorAttributeVar	ReadVariable (Managed item, SCR_AttributesManagerEditorComponent manager)
	Function to fill attribute's variable.

override void	WriteVariable (Managed item, SCR_BaseEditorAttributeVar var, SCR_AttributesManagerEditorComponent manager, int playerID)

override void	UpdateInterlinkedVariables (SCR_BaseEditorAttributeVar var, SCR_AttributesManagerEditorComponent manager, bool isInit=false)
	Updates the interlinked variables.

void	GetYearArray (notnull out array< int > yearArray)
	Get year array for dynamic description.

int	GetYearByIndex (int index)

override int	GetEntries (notnull array< ref SCR_BaseEditorAttributeEntry > outEntries)
	Get entries to be shown in GUI lists.

override void	PreviewVariable (bool setPreview, SCR_AttributesManagerEditorComponent manager)
	Preview the attribute while editing.

Public Member Functions inherited from SCR_BaseEditorAttribute
void	ResetAttribute ()
	Reset the attribute Called in SCR_AttributesManagerEditorComponent when it loops through valid attributes.

SCR_EditorAttributeUIInfo	GetUIInfo ()
	Get UIinfo, Description is attribute description and Icon is used when the attribute description is overridden.

int	GetDynamicDescriptionArray (notnull out array< SCR_BaseAttributeDynamicDescription > dynamicDescriptionArray)
	Get array of dynamic descriptions.

bool	IsServer ()
	Check if the server should be extracted and applied on server.

ResourceName	GetCategoryConfig ()
	Get category config file.

ResourceName	GetLayout ()
	Get UI layout.

bool	BoolAllowDuplicate ()
	Return True if attribute is allowed to be duplicate.

bool	IsSerializable ()

bool	SetVariable (SCR_BaseEditorAttributeVar var)
	Set a variable to this attribute.

void	ClearVar ()
	Set var null.

void	ClearCopyVar ()
	Set copy var null.

ScriptInvoker	GetOnVarChanged ()
	Get On Var changed script invoker.

void	Enable (bool enabled)
	Sends out an event which UI listens to to enable/disable UI component.

void	ToggleSelected (bool selected, int index)
	Sends out an event which UI listens if is selected.

void	SetAsSubAttribute ()
	Sends set bool UI listens to to enable/disable UI component.

bool	GetInitCalled ()
	Get if init is called.

void	SetInitCalled (bool initCalled)
	Set Init called.

bool	GetIsMultiSelect ()
	Get is multi select var Multi select means that multiple entities where selected when editing attributes and those entities share the same attributes.

void	SetIsMultiSelect (bool isMultiSelect)
	Set if variable is multiselect Multi select means that multiple entities were selected when editing attributes and those entities share the same attributes.

bool	GetHasConflictingValues ()
	Get has conflicting values.

void	SetHasConflictingValues (bool hasConflictingValues)
	Set if varriable is has conflicting values.

void	SetIsOverridingValues (bool isOverridingValues)
	Set is overriding values.

bool	GetIsOverridingValues ()
	Get is overriding values.

bool	IsEnabled ()
	Get if The Attribute is Enabled.

bool	GetIsSubAttribute ()
	Get if The Attribute is Enabled.

ScriptInvoker	GetOnToggleEnable ()
	Get On ToggleEnable script invoker.

ScriptInvoker	GetOnToggleButtonSelected ()
	Get OnToggleSelected script invoker.

ScriptInvoker	GetOnSetAsSubAttribute ()
	Get On ToggleEnable script invoker.

SCR_BaseEditorAttributeVar	GetVariable (bool createWhenNull=false)
	Get variable of this attribute.

SCR_BaseEditorAttributeVar	GetCopyVariable ()
	Get Copy variable of this attribute.

SCR_BaseEditorAttributeVar	GetVariableOrCopy ()
	Get variable or copy variable of this attribute.

void	CreateCopyVariable ()
	Get Copy variable of this attribute.

bool	GetConflictingAttributeWasReset ()
	Get if conflicting attribute was reset so UI knows to set default values if it was not active on reset.

void	SetConflictingAttributeWasReset (bool wasReset)
	Sets conflicting attribute was reset so UI knows to set default values if it was not active on reset.

SSnapshot	GetSnapshot ()
	Get snapshot which holds original attribute's value.

ScriptInvoker	GetOnExternalnChange ()
	Get event called when attribute var is changed from outside.

void	StartEditing (SCR_BaseEditorAttributeVar var, SSnapshot snapshot)
	Initialise editing variables.

void	StopEditing ()
	Reset editing variables.

void	TelegraphChange (bool isReset)

void	Initialize ()
	Method for initialization of base editor attribute.

Public Attributes
ref array< ref int >	m_aYearArray = new array<ref int>()

Protected Member Functions
void	CreateYearArray ()

int	GetYearIndex (int year)

Protected Member Functions inherited from SCR_BaseEditorAttribute
SCR_BaseEditorAttributeVar	CreateDefaultVariable ()
	Create a default bool (false) variable.

bool	IsGameMode (Managed item)

Protected Attributes
string	m_sDateFormatOrder

LocalizedString	m_sDayLabel

LocalizedString	m_sMonthLabel

LocalizedString	m_sYearLabel

ref array< ref LocalizedString >	m_aMonthList

int	m_iYearStartDate

int	m_iYearEndDate

Protected Attributes inherited from SCR_BaseEditorAttribute
ref SCR_EditorAttributeUIInfo	m_UIInfo

ResourceName	m_CategoryConfig

ResourceName	m_Layout

ref array< ref SCR_BaseAttributeDynamicDescription >	m_aAttributeDynamicDescriptions

bool	m_bAttributeEnabled = true

bool	m_bIsSubAttribute

bool	m_bInitCalled

bool	m_bConflictingAttributeWasReset

BaseGameMode	m_GameMode

bool	m_bIsMultiSelect = false

bool	m_bHasConflictingValues = false

bool	m_bOverridingValues = false

ref SCR_BaseEditorAttributeVar	m_Var

ref SCR_BaseEditorAttributeVar	m_CopyVar

ref SSnapshot	m_Snapshot

ref ScriptInvoker	Event_OnExternalChange

ref ScriptInvoker	Event_OnVarChanged = new ScriptInvoker

ref ScriptInvoker	Event_OnToggleEnable = new ScriptInvoker

ref ScriptInvoker	Event_OnToggleButtonSelected = new ScriptInvoker

ref ScriptInvoker	Event_OnSetAsSubAttribute = new ScriptInvoker

Member Function Documentation

◆ CreateYearArray()

void SCR_DateEditorAttribute.CreateYearArray ( )

protected

◆ GetEntries()

override int SCR_DateEditorAttribute.GetEntries ( notnull array< ref SCR_BaseEditorAttributeEntry > outEntries )

Get entries to be shown in GUI lists.

To be overridden by child classes. \outEntries Entries

Returns: Number of entries

Implements SCR_BaseEditorAttribute.

◆ GetYearArray()

void SCR_DateEditorAttribute.GetYearArray ( notnull out array< int > yearArray )

Get year array for dynamic description.

Parameters

[out] yearArray Array of years

◆ GetYearByIndex()

int SCR_DateEditorAttribute.GetYearByIndex ( int index )

◆ GetYearIndex()

int SCR_DateEditorAttribute.GetYearIndex ( int year )

protected

◆ PreviewVariable()

override void SCR_DateEditorAttribute.PreviewVariable	(	bool	setPreview,
		SCR_AttributesManagerEditorComponent	manager )

Preview the attribute while editing.

Parameters

manager Attribute manager which is currently managing the attribute. Will be null when the attribute is used for session saving!

Implements SCR_BaseEditorAttribute.

◆ ReadVariable()

override SCR_BaseEditorAttributeVar SCR_DateEditorAttribute.ReadVariable	(	Managed	item,
		SCR_AttributesManagerEditorComponent	manager )

Function to fill attribute's variable.

It should connect to API which controls what the attribute represents (e.g., getting fuel from fuel system). To be overridden by child classes.

Parameters

item	Item from which the value is extracted from
manager	Attribute manager which is currently managing the attribute. Will be null when the attribute is used for session saving!

Returns: Variable or null to ignore the attribute

Implements SCR_BaseEditorAttribute.

◆ UpdateInterlinkedVariables()

override void SCR_DateEditorAttribute.UpdateInterlinkedVariables	(	SCR_BaseEditorAttributeVar	var,
		SCR_AttributesManagerEditorComponent	manager,
		bool	isInit = false )

Updates the interlinked variables.

Parameters

var
manager
isInit

Implements SCR_BaseEditorAttribute.

◆ WriteVariable()

override void SCR_DateEditorAttribute.WriteVariable	(	Managed	item,
		SCR_BaseEditorAttributeVar	var,
		SCR_AttributesManagerEditorComponent	manager,
		int	playerID )

Implements SCR_BaseEditorAttribute.

Member Data Documentation

◆ m_aMonthList

ref array<ref LocalizedString> SCR_DateEditorAttribute.m_aMonthList

protected

◆ m_aYearArray

ref array<ref int> SCR_DateEditorAttribute.m_aYearArray = new array<ref int>()

◆ m_iYearEndDate

int SCR_DateEditorAttribute.m_iYearEndDate

protected

◆ m_iYearStartDate

int SCR_DateEditorAttribute.m_iYearStartDate

protected

◆ m_sDateFormatOrder

string SCR_DateEditorAttribute.m_sDateFormatOrder

protected

◆ m_sDayLabel

LocalizedString SCR_DateEditorAttribute.m_sDayLabel

protected

◆ m_sMonthLabel

LocalizedString SCR_DateEditorAttribute.m_sMonthLabel

protected

◆ m_sYearLabel

LocalizedString SCR_DateEditorAttribute.m_sYearLabel

protected

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

Game/Editor/Containers/Attributes/SCR_DateEditorAttribute.c

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ CreateYearArray()

◆ GetEntries()

◆ GetYearArray()

◆ GetYearByIndex()

◆ GetYearIndex()

◆ PreviewVariable()

◆ ReadVariable()

◆ UpdateInterlinkedVariables()

◆ WriteVariable()

Member Data Documentation

◆ m_aMonthList

◆ m_aYearArray

◆ m_iYearEndDate

◆ m_iYearStartDate

◆ m_sDateFormatOrder

◆ m_sDayLabel

◆ m_sMonthLabel

◆ m_sYearLabel