Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_AttributesManagerEditorComponent.c File Reference

Go to the source code of this file.

Classes

class  SCR_AttributesManagerEditorComponentClass

Functions

void StartEditing (Managed item)
void StartEditing (notnull array< Managed > items, bool onlyServer=true)
void StartEditingServer (array< int > itemIds)
void StartEditingOwner (notnull array< int > attributesIds, notnull array< ref SCR_BaseEditorAttributeVar > attributesVars, notnull array< ref EEditorAttributeMultiSelect > attributesMultiSelect)
bool GetIsAttributeDuplicate (typename type)
void ConfirmEditing ()
void ConfirmEditingServer (notnull array< int > attributesIds, notnull array< ref SCR_BaseEditorAttributeVar > attributesVars, int PlayerID)
void CancelEditing ()
void CancelEditingServer ()
void Reset (bool telegraphChange)
void Clean ()
int GetVariables (bool onlyServer, notnull array< Managed > items, notnull out array< int > outIds, notnull out array< ref SCR_BaseEditorAttributeVar > outVars, notnull out array< ref EEditorAttributeMultiSelect > outAttributesMultiSelect)
bool CanOpenAttributeDialog (notnull array< Managed > items)
bool SetAttributeVariable (typename type, SCR_BaseEditorAttributeVar var)
bool GetAttributeVariable (typename type, out SCR_BaseEditorAttributeVar var)
int GetActiveAttributesOfType (typename type, notnull out array< SCR_BaseEditorAttribute > attributes, bool includedInherit=true, SCR_BaseEditorAttribute ignoreAttribute=null)
bool GetActiveAttribute (typename type, out SCR_BaseEditorAttribute attribute)
bool SetAttributeEnabled (typename type, bool enabled)
bool SetAttributeSelected (typename type, bool selected, int index=-1)
bool SetAttributeAsSubAttribute (typename type)
SCR_BaseEditorAttribute GetAttributeRef (typename type)
int GetEditedAttributes (out notnull array< SCR_BaseEditorAttribute > outAttributes)
int GetEditedItems (out notnull array< Managed > outitems)
ScriptInvoker GetOnAttributesRequest ()
ScriptInvoker GetOnAttributesStart ()
ScriptInvoker GetOnAttributesConfirm ()
ScriptInvoker GetOnAttributesCancel ()
ScriptInvoker GetOnResetAttributes ()
ScriptInvoker GetOnAttributeChangesApplied ()
ScriptInvoker GetOnAttributeDescriptionChanged ()
ScriptInvoker GetOnAttributeCategoryChanged ()
SCR_EditorAttributeUIInfo GetConflictingAttributeUIInfo ()
void SetCurrentCategory (ResourceName category)
ResourceName GetCurrentCategory ()
bool GetChangedAttributesOnce ()
void SetAttributeDescription (SCR_EditorAttributeUIInfo uiInfo, string customDescription=string.Empty, string param1=string.Empty, string param2=string.Empty, string param3=string.Empty)
override void EOnEditorActivate ()
override void EOnEditorDeactivate ()
override void EOnEditorInit ()
override void EOnEditorInitServer ()

Variables

SCR_AttributesManagerEditorComponentClass SNAPSHOT_SIZE = 96
ref SCR_EditorAttributeUIInfo m_ConflictingAttributeUIInfo
bool m_bHasChangedAttributesOnce = false
ResourceName m_CurrentCategory

Function Documentation

◆ CancelEditing()

void CancelEditing ( )
protected

Cancel changes made during editing. Must be called on editor owner.

Definition at line 417 of file SCR_AttributesManagerEditorComponent.c.

◆ CancelEditingServer()

void CancelEditingServer ( )
protected

Definition at line 438 of file SCR_AttributesManagerEditorComponent.c.

◆ CanOpenAttributeDialog()

bool CanOpenAttributeDialog ( notnull array< Managed > items)
protected
Parameters
[in]items
Returns

Definition at line 599 of file SCR_AttributesManagerEditorComponent.c.

◆ Clean()

void Clean ( )
protected

Definition at line 510 of file SCR_AttributesManagerEditorComponent.c.

◆ ConfirmEditing()

void ConfirmEditing ( )
protected

Confirm changes made during editing. Must be called on editor owner.

Definition at line 297 of file SCR_AttributesManagerEditorComponent.c.

◆ ConfirmEditingServer()

void ConfirmEditingServer ( notnull array< int > attributesIds,
notnull array< ref SCR_BaseEditorAttributeVar > attributesVars,
int PlayerID )
protected

Definition at line 384 of file SCR_AttributesManagerEditorComponent.c.

◆ EOnEditorActivate()

override void EOnEditorActivate ( )
protected

Definition at line 971 of file SCR_AttributesManagerEditorComponent.c.

◆ EOnEditorDeactivate()

override void EOnEditorDeactivate ( )
protected

Definition at line 977 of file SCR_AttributesManagerEditorComponent.c.

◆ EOnEditorInit()

override void EOnEditorInit ( )
protected

Definition at line 983 of file SCR_AttributesManagerEditorComponent.c.

◆ EOnEditorInitServer()

override void EOnEditorInitServer ( )
protected

Definition at line 1003 of file SCR_AttributesManagerEditorComponent.c.

◆ GetActiveAttribute()

bool GetActiveAttribute ( typename type ,
out SCR_BaseEditorAttribute attribute )
protected

Gets the attribute in the atribute window

Parameters
[in]typeClass of attribute
[out]attributeattribute to get
Returns
if the class is succesfully found

Definition at line 711 of file SCR_AttributesManagerEditorComponent.c.

◆ GetActiveAttributesOfType()

int GetActiveAttributesOfType ( typename type ,
notnull out array< SCR_BaseEditorAttribute > attributes,
bool includedInherit = true,
SCR_BaseEditorAttribute ignoreAttribute = null )
protected

Get list of all attributes of given type (or inherits from type)

Parameters
[in]typeClass of attribute
[out]attributeslist of attributes of type
[in]includedInheritIf true will also get inherit classes else will only get the attributes of given type
[in]ignoreAttributeAdd if a given attribute should be ignored
Returns
Count of the found attributes

Definition at line 690 of file SCR_AttributesManagerEditorComponent.c.

◆ GetAttributeRef()

SCR_BaseEditorAttribute GetAttributeRef ( typename type )
protected
Parameters
[in]type
Returns

Definition at line 827 of file SCR_AttributesManagerEditorComponent.c.

◆ GetAttributeVariable()

bool GetAttributeVariable ( typename type ,
out SCR_BaseEditorAttributeVar var )
protected

Gets the value of an attribute in the atribute window

Parameters
[in]typeClass of attribute to set value
[out]varValue to get
Returns
bool if the class is succesfully found

Definition at line 663 of file SCR_AttributesManagerEditorComponent.c.

◆ GetChangedAttributesOnce()

bool GetChangedAttributesOnce ( )
protected

Get if user has changed attributes once

Returns
m_bHasChangedAttributesOnce

Definition at line 949 of file SCR_AttributesManagerEditorComponent.c.

◆ GetConflictingAttributeUIInfo()

SCR_EditorAttributeUIInfo GetConflictingAttributeUIInfo ( )
protected

Info displayed when attribute is locked if it is a conflicting attribute

Returns
The conflicting attribute UI info

Definition at line 926 of file SCR_AttributesManagerEditorComponent.c.

◆ GetCurrentCategory()

ResourceName GetCurrentCategory ( )
protected
Returns
Get current category config.

Definition at line 941 of file SCR_AttributesManagerEditorComponent.c.

◆ GetEditedAttributes()

int GetEditedAttributes ( out notnull array< SCR_BaseEditorAttribute > outAttributes)
protected

Get currently edited attributes

Parameters
[in]outAttributesArray to be filled with attributes
Returns
Number of attributes

Definition at line 842 of file SCR_AttributesManagerEditorComponent.c.

◆ GetEditedItems()

int GetEditedItems ( out notnull array< Managed > outitems)
protected

Get currently edited items

Parameters
[in]outAttributesArray to be filled with items
Returns
Number of items

Definition at line 851 of file SCR_AttributesManagerEditorComponent.c.

◆ GetIsAttributeDuplicate()

bool GetIsAttributeDuplicate ( typename type )
protected

Definition at line 275 of file SCR_AttributesManagerEditorComponent.c.

◆ GetOnAttributeCategoryChanged()

ScriptInvoker GetOnAttributeCategoryChanged ( )
protected

Get script invoker that is called everytime category is changed

Returns
Script invoker OnAttributeCategoryChanged

Definition at line 918 of file SCR_AttributesManagerEditorComponent.c.

◆ GetOnAttributeChangesApplied()

ScriptInvoker GetOnAttributeChangesApplied ( )
protected

Get event called when attribute changes are applied

Returns
Script invoker

Definition at line 902 of file SCR_AttributesManagerEditorComponent.c.

◆ GetOnAttributeDescriptionChanged()

ScriptInvoker GetOnAttributeDescriptionChanged ( )
protected

Get event called when attribute description changes and should be displayed in the attribute UI dailog

Returns
Script invoker Event_OnAttributeDescriptionChanged

Definition at line 910 of file SCR_AttributesManagerEditorComponent.c.

◆ GetOnAttributesCancel()

ScriptInvoker GetOnAttributesCancel ( )
protected

Get event called when editing attributes is canceled. Called only for editor user.

Returns
Script invoker

Definition at line 886 of file SCR_AttributesManagerEditorComponent.c.

◆ GetOnAttributesConfirm()

ScriptInvoker GetOnAttributesConfirm ( )
protected

Get event called when editing attributes is confirmed. Called only for editor user.

Returns
Script invoker

Definition at line 878 of file SCR_AttributesManagerEditorComponent.c.

◆ GetOnAttributesRequest()

ScriptInvoker GetOnAttributesRequest ( )
protected

Get event called when request for editing attributes is sent to server. Called only for editor user.

Returns
Script invoker

Definition at line 860 of file SCR_AttributesManagerEditorComponent.c.

◆ GetOnAttributesStart()

ScriptInvoker GetOnAttributesStart ( )
protected

Get event called when editing attributes is confirmed by server. Called only for editor user.

Returns
Script invoker

Definition at line 869 of file SCR_AttributesManagerEditorComponent.c.

◆ GetOnResetAttributes()

ScriptInvoker GetOnResetAttributes ( )
protected

Get event called when attributes are reset.

Returns
Script invoker

Definition at line 894 of file SCR_AttributesManagerEditorComponent.c.

◆ GetVariables()

int GetVariables ( bool onlyServer,
notnull array< Managed > items,
notnull out array< int > outIds,
notnull out array< ref SCR_BaseEditorAttributeVar > outVars,
notnull out array< ref EEditorAttributeMultiSelect > outAttributesMultiSelect )
protected

Definition at line 525 of file SCR_AttributesManagerEditorComponent.c.

◆ Reset()

void Reset ( bool telegraphChange)
protected

Reset values of currently edited attributes to the state they had when the editing started. Must be called on editor owner.

Parameters
[in]telegraphChangeTrue to update GUI when attribute value is changed

Definition at line 452 of file SCR_AttributesManagerEditorComponent.c.

◆ SetAttributeAsSubAttribute()

bool SetAttributeAsSubAttribute ( typename type )
protected

Called to send out an event that makes sure the given attribute knows it is a sub attribute for another attribute which sets so visual differences

Parameters
[in]typeclass of attribute
Returns
if the class is succesfully found

Definition at line 800 of file SCR_AttributesManagerEditorComponent.c.

◆ SetAttributeDescription()

void SetAttributeDescription ( SCR_EditorAttributeUIInfo uiInfo,
string customDescription = string.Empty,
string param1 = string.Empty,
string param2 = string.Empty,
string param3 = string.Empty )
protected

Calls an event to set the attribute Description displayed in the Attributes dialog

Parameters
[in]uiInfo
[in]customDescription
[in]param1param in text
[in]param2param in text
[in]param3param in text

Definition at line 961 of file SCR_AttributesManagerEditorComponent.c.

◆ SetAttributeEnabled()

bool SetAttributeEnabled ( typename type ,
bool enabled )
protected

Called to send out an event that the attribute is enabled or disabled

Parameters
[in]typeClass of attribute to set value
[in]enabledenable value to set
Returns
if the class is succesfully found

Definition at line 735 of file SCR_AttributesManagerEditorComponent.c.

◆ SetAttributeSelected()

bool SetAttributeSelected ( typename type ,
bool selected,
int index = -1 )
protected

Called to send out an event that the attribute should be selected. Think of a slider being used which is also set by presets

Parameters
[in]typeclass of attribute to set value
[in]selectedvalue to set
[in]indexoptionally an index of a element that needs to be set selected
Returns
if the class is succesfully found

Definition at line 771 of file SCR_AttributesManagerEditorComponent.c.

◆ SetAttributeVariable()

bool SetAttributeVariable ( typename type ,
SCR_BaseEditorAttributeVar var )
protected

Sets the value of an attribute in the atribute window This is called seperetly from the UI and is for attributes to influence other attributes

Parameters
[in]typeClass of attribute to set value
[in]varvalue to set
Returns
bool if the class is succesfully found

Definition at line 634 of file SCR_AttributesManagerEditorComponent.c.

◆ SetCurrentCategory()

void SetCurrentCategory ( ResourceName category)
protected

Set current category config.

Parameters
[in]categoryCategory config

Definition at line 934 of file SCR_AttributesManagerEditorComponent.c.

◆ StartEditing() [1/2]

void StartEditing ( Managed item)
protected

Start attributes editing of single item. Must be called on editor owner.

Parameters
[in]item
Returns
item Edited MapItem

Definition at line 93 of file SCR_AttributesManagerEditorComponent.c.

◆ StartEditing() [2/2]

void StartEditing ( notnull array< Managed > items,
bool onlyServer = true )
protected

Start attributes editing of multiple items. Must be called on editor owner.

  • Server attributes will be sent to server, which will fill them with values and send them back.
  • Once back, Event_OnAttributesStart is invoked.
  • If all attributes are local, no server verification is performed.
    Parameters
    [in]items
    [in]onlyServer
    Returns
    item Edited items (must be explicitly array<Managed>, not another type! Even when the array element itself inherits from Managed)

Definition at line 123 of file SCR_AttributesManagerEditorComponent.c.

◆ StartEditingOwner()

void StartEditingOwner ( notnull array< int > attributesIds,
notnull array< ref SCR_BaseEditorAttributeVar > attributesVars,
notnull array< ref EEditorAttributeMultiSelect > attributesMultiSelect )
protected

Definition at line 215 of file SCR_AttributesManagerEditorComponent.c.

◆ StartEditingServer()

void StartEditingServer ( array< int > itemIds)
protected

Definition at line 171 of file SCR_AttributesManagerEditorComponent.c.

Variable Documentation

◆ m_bHasChangedAttributesOnce

bool m_bHasChangedAttributesOnce = false
protected

Definition at line 78 of file SCR_AttributesManagerEditorComponent.c.

◆ m_ConflictingAttributeUIInfo

ref SCR_EditorAttributeUIInfo m_ConflictingAttributeUIInfo
protectedattribute

Definition at line 62 of file SCR_AttributesManagerEditorComponent.c.

◆ m_CurrentCategory

ResourceName m_CurrentCategory
protected

Definition at line 82 of file SCR_AttributesManagerEditorComponent.c.