Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
SCR_GameOverFactionsEditorAttribute Interface Reference
Inheritance diagram for SCR_GameOverFactionsEditorAttribute:
[legend]

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)
 
- Public Member Functions inherited from SCR_BaseMultiSelectPresetsEditorAttribute
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 int GetEntries (notnull array< ref SCR_BaseEditorAttributeEntry > outEntries)
 Get entries to be shown in GUI lists.
 
override int GetEntries (notnull array< ref SCR_BaseEditorAttributeEntry > outEntries)
 Get entries to be shown in GUI lists.
 
override int GetEntries (notnull array< ref SCR_BaseEditorAttributeEntry > outEntries)
 Get entries to be shown in GUI lists.
 
- 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 ()
 
sealed bool SetVariable (SCR_BaseEditorAttributeVar var)
 Set a variable to this attribute.
 
sealed void ClearVar ()
 Set var null.
 
sealed void ClearCopyVar ()
 Set copy var null.
 
sealed ScriptInvoker GetOnVarChanged ()
 Get On Var changed script invoker.
 
sealed void Enable (bool enabled)
 Sends out an event which UI listens to to enable/disable UI component.
 
sealed void ToggleSelected (bool selected, int index)
 Sends out an event which UI listens if is selected.
 
sealed 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.
 
sealed ScriptInvoker GetOnToggleEnable ()
 Get On ToggleEnable script invoker.
 
sealed ScriptInvoker GetOnToggleButtonSelected ()
 Get OnToggleSelected script invoker.
 
sealed ScriptInvoker GetOnSetAsSubAttribute ()
 Get On ToggleEnable script invoker.
 
sealed SCR_BaseEditorAttributeVar GetVariable (bool createWhenNull=false)
 Get variable of this attribute.
 
sealed SCR_BaseEditorAttributeVar GetCopyVariable ()
 Get Copy variable of this attribute.
 
sealed SCR_BaseEditorAttributeVar GetVariableOrCopy ()
 Get variable or copy variable of this attribute.
 
sealed void CreateCopyVariable ()
 Get Copy variable of this attribute.
 
sealed bool GetConflictingAttributeWasReset ()
 Get if conflicting attribute was reset so UI knows to set default values if it was not active on reset.
 
sealed void SetConflictingAttributeWasReset (bool wasReset)
 Sets conflicting attribute was reset so UI knows to set default values if it was not active on reset.
 
sealed SSnapshot GetSnapshot ()
 Get snapshot which holds original attribute's value.
 
sealed ScriptInvoker GetOnExternalnChange ()
 Get event called when attribute var is changed from outside.
 
sealed void StartEditing (SCR_BaseEditorAttributeVar var, SSnapshot snapshot)
 Initialise editing variables.
 
sealed void StopEditing ()
 Reset editing variables.
 
sealed void TelegraphChange (bool isReset)
 
SCR_BaseEditorAttributeVar ReadVariable (Managed item, SCR_AttributesManagerEditorComponent manager)
 Function to fill attribute's variable.
 
void WriteVariable (Managed item, SCR_BaseEditorAttributeVar var, SCR_AttributesManagerEditorComponent manager, int playerID)
 
void PreviewVariable (bool setPreview, SCR_AttributesManagerEditorComponent manager)
 Preview the attribute while editing.
 
void UpdateInterlinkedVariables (SCR_BaseEditorAttributeVar var, SCR_AttributesManagerEditorComponent manager, bool isInit=false)
 Updates the interlinked variables.
 
int GetEntries (notnull array< ref SCR_BaseEditorAttributeEntry > outEntries)
 Get entries to be shown in GUI lists.
 
void Initialize ()
 Method for initialization of base editor attribute.
 

Protected Member Functions

int GetEditorGameOverInfoArray (notnull array< SCR_BaseGameOverScreenInfo > gameOverScreens, notnull out array< SCR_BaseGameOverScreenInfo > editorGameOverScreens)
 
override void CreatePresets ()
 
- Protected Member Functions inherited from SCR_BaseMultiSelectPresetsEditorAttribute
void AddOrderedState (bool state)
 
bool GetOrderedState ()
 
int GetStateVectorIndex ()
 
bool AddFlag (int flag, int vectorIndex=0)
 
bool SetFlags (int flags, int vectorIndex=0)
 
int GetFlags (int vectorIndex)
 
bool HasFlag (int flagToCheck)
 
void ResetLoopValues (bool increaseVectorIndex)
 
vector GetFlagVector ()
 
void CreatePresets ()
 
- Protected Member Functions inherited from SCR_BaseEditorAttribute
SCR_BaseEditorAttributeVar CreateDefaultVariable ()
 Create a default bool (false) variable.
 
bool IsGameMode (Managed item)
 

Additional Inherited Members

- Protected Attributes inherited from SCR_BaseMultiSelectPresetsEditorAttribute
bool m_bCustomFlags
 
vector m_vFlags
 
- Protected Attributes inherited from SCR_BasePresetsEditorAttribute
int m_iButtonsOnRow
 
bool m_bHasRandomizeButton
 
ResourceName m_sRandomizeButtonIcon
 
bool m_bUseIcon
 
bool m_bHasButtonDescription
 
LocalizedString m_sButtonDescription
 
float m_fButtonHeight
 
- Protected Attributes inherited from SCR_BaseFloatValueHolderEditorAttribute
ref array< ref SCR_EditorAttributeFloatStringValueHolderm_aValues
 
- Protected Attributes inherited from SCR_BaseEditorAttribute
ref SCR_EditorAttributeUIInfo m_UIInfo
 
ResourceName m_CategoryConfig
 
ResourceName m_Layout
 
ref array< ref SCR_BaseAttributeDynamicDescriptionm_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

◆ CreatePresets()

override void SCR_GameOverFactionsEditorAttribute.CreatePresets ( )
protected

◆ GetEditorGameOverInfoArray()

int SCR_GameOverFactionsEditorAttribute.GetEditorGameOverInfoArray ( notnull array< SCR_BaseGameOverScreenInfo gameOverScreens,
notnull out array< SCR_BaseGameOverScreenInfo editorGameOverScreens 
)
protected

◆ ReadVariable()

override SCR_BaseEditorAttributeVar SCR_GameOverFactionsEditorAttribute.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
itemItem from which the value is extracted from
managerAttribute 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_BaseMultiSelectPresetsEditorAttribute.

◆ WriteVariable()

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

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