Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_BaseEditorComponent Class Reference
Editor » Entities » Editor Components
Inheritance diagram for SCR_BaseEditorComponent:
ScriptComponent SCR_BudgetEditorComponent SCR_CameraDataEditorComponent SCR_CameraEditorComponent SCR_CameraFiltersEditorComponent SCR_CameraParticlesEditorComponent SCR_ContentBrowserEditorComponent SCR_DebugEditorComponent SCR_DynamicSimulationEditorComponent SCR_EntitiesManagerEditorComponent SCR_FactionWarningManagerEditorComponent SCR_HighlightedEditorComponent SCR_HintEditorComponent SCR_InputLayoutEditorComponent SCR_LayersEditorComponent SCR_MapEditorComponent SCR_MenuEditorComponent SCR_MenuLayoutEditorComponent SCR_MenuOverlaysEditorComponent SCR_MusicEditorComponent SCR_PingEditorComponent SCR_PlacingEditorComponent SCR_PlayerDelegateEditorComponent SCR_PlayersManagerEditorComponent SCR_PrefabsCacheEditorComponent SCR_PreviewEntityEditorComponent SCR_ServerInfoEditorComponent SCR_StatesEditorComponent SCR_TestEditorComponent SCR_TransformingEditorComponent SCR_WorldEntityDelegateEditorComponent

Protected Member Functions

sealed void OnInitBase ()
sealed void OnDeleteBase ()
sealed void OnRequestBase (bool isOpen)
sealed void OnOpenedBase ()
sealed void OnClosedBase ()
sealed void OnPreActivateBase ()
sealed void OnActivateBase ()
sealed bool OnActivateAsyncBase (int attempt)
sealed void OnPostActivateBase ()
sealed void OnDeactivateBase ()
sealed void OnPostDeactivateBase ()
sealed bool OnDeactivateAsyncBase (int attempt)
sealed void OnEffectBase (SCR_BaseEditorEffect effect)
SCR_EditorManagerEntity GetManager ()
SCR_BaseEditorComponent FindEditorComponent (typename type, bool showError=false, bool modeFirst=false)
EntityComponentPrefabData GetEditorComponentData ()
bool IsRemoved ()
void ResetEditorComponent ()
ScriptInvoker GetOnEffect ()
bool IsOnEditorManager ()
bool IsOwner ()
bool IsProxy ()
bool IsMaster ()
bool IsAdmin ()
SCR_BaseEditorComponent GetParentComponent ()
void SetParentComponent (SCR_BaseEditorComponent parent)
void SendNotification (ENotification notificationID, int selfID=0, int targetID=0, vector position=vector.Zero)
void InitServer ()
void InitOwner ()
override void OnPostInit (IEntity owner)
void SCR_BaseEditorComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
void ~SCR_BaseEditorComponent ()
Template Methods (Owner)

Methods to be overridden by child classes, called where the editor is local.

void EOnEditorInit ()
 When the entity is created.
void EOnEditorDelete ()
 When the entity is destroyed.
void EOnEditorRequest (bool isOpen)
 When opening/closing request is sent to server.
void EOnEditorOpen ()
 When the editor is opened.
void EOnEditorClose ()
 When the editor is closed.
void EOnEditorPreActivate ()
void EOnEditorActivate ()
bool EOnEditorActivateAsync (int attempt)
void EOnEditorPostActivate ()
 When the component is activated, but after EOnEditorActivate() function was called in all components.
void EOnEditorDeactivate ()
bool EOnEditorDeactivateAsync (int attempt)
void EOnEditorPostDeactivate ()
 When the component is deactivated, but after the next mode is activated.
void EOnEditorDebug (array< string > debugTexts)
 Every frame while the editor is opened and debug menu is shown.
void EOnEffect (SCR_BaseEditorEffect effect)
 When an effect is created in reaction an an event.
Template Methods (Server)

Methods to be overridden by child classes, called on server.

void EOnEditorInitServer ()
 When the entity is created (called on server).
void EOnEditorDeleteServer ()
 When the entity is destroyed (called on server).
void EOnEditorOpenServer ()
 When the editor is opened (called on server).
void EOnEditorOpenServerCallback ()
 When the editor is opened (called on server after async loading finished on client).
void EOnEditorCloseServer ()
 When the editor is closed (called on server).
void EOnEditorCloseServerCallback ()
 When the editor is closed (called on server after async loading finished on client).
void EOnEditorActivateServer ()
void EOnEditorDeactivateServer ()

Static Protected Member Functions

static Managed GetInstance (typename type, bool showError=false, bool modeFirst=false)
static Managed GetInstance (SCR_EditorBaseEntity editorManager, typename type, bool showError=false)
static int GetAllInstances (typename type, out notnull array< Managed > outComponents)

Protected Attributes

SCR_EditorBaseEntity m_Owner
SCR_EditorManagerEntity m_Manager
SCR_BaseEditorComponent m_Parent
RplComponent m_RplComponent

Detailed Description

Base class for editor components.

  • Editor components handle actual functionality of the editor, like GUI, camera or entity management.
  • They must inherit from this class and be attached to SCR_EditorBaseEntity, otherwise they won't initialize.
  • The base class offers several pre-made functions from which custom editor components can inherit, e.g., EOnEditorOpen or EOnEditorActivate.

Execution Order

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

Definition at line 119 of file SCR_BaseEditorComponent.c.

Constructor & Destructor Documentation

◆ SCR_BaseEditorComponent()

void SCR_BaseEditorComponent::SCR_BaseEditorComponent ( IEntityComponentSource src,
IEntity ent,
IEntity parent )
inlineprotected
Parameters
[in]src
[in]ent
[in]parent

Definition at line 683 of file SCR_BaseEditorComponent.c.

◆ ~SCR_BaseEditorComponent()

void SCR_BaseEditorComponent::~SCR_BaseEditorComponent ( )
inlineprotected

Definition at line 700 of file SCR_BaseEditorComponent.c.

Member Function Documentation

◆ EOnEditorActivate()

void SCR_BaseEditorComponent::EOnEditorActivate ( )
protected

When the component is activated.

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorActivateAsync()

bool SCR_BaseEditorComponent::EOnEditorActivateAsync ( int attempt)
inlineprotected

When the component is activated. Asynchronous, can take multiple frames in case of complex operations.

Parameters
[in]attemptNumber of previous attempts to activate the component.
Returns
True if the component is activated, false if it isn't (another attempt will follow in the next frame).

Definition at line 170 of file SCR_BaseEditorComponent.c.

◆ EOnEditorActivateServer()

void SCR_BaseEditorComponent::EOnEditorActivateServer ( )
protected

When the component is activated (called on server)

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorClose()

void SCR_BaseEditorComponent::EOnEditorClose ( )
protected

When the editor is closed.

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorCloseServer()

void SCR_BaseEditorComponent::EOnEditorCloseServer ( )
protected

When the editor is closed (called on server).

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorCloseServerCallback()

void SCR_BaseEditorComponent::EOnEditorCloseServerCallback ( )
protected

When the editor is closed (called on server after async loading finished on client).

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorDeactivate()

void SCR_BaseEditorComponent::EOnEditorDeactivate ( )
protected

When the component is deactivated.

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorDeactivateAsync()

bool SCR_BaseEditorComponent::EOnEditorDeactivateAsync ( int attempt)
inlineprotected

When the component is deactivated. Asynchronous, can take multiple frames in case of complex operations.

Parameters
[in]attemptNumber of previous attempts to deactivate the component.
Returns
true if the component is activated, false if it isn't (another attempt will follow in the next frame).

Definition at line 189 of file SCR_BaseEditorComponent.c.

◆ EOnEditorDeactivateServer()

void SCR_BaseEditorComponent::EOnEditorDeactivateServer ( )
protected

When the component is deactivated (called on server)

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorDebug()

void SCR_BaseEditorComponent::EOnEditorDebug ( array< string > debugTexts)
protected

Every frame while the editor is opened and debug menu is shown.

◆ EOnEditorDelete()

void SCR_BaseEditorComponent::EOnEditorDelete ( )
protected

When the entity is destroyed.

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorDeleteServer()

void SCR_BaseEditorComponent::EOnEditorDeleteServer ( )
protected

When the entity is destroyed (called on server).

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorInit()

void SCR_BaseEditorComponent::EOnEditorInit ( )
protected

When the entity is created.

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorInitServer()

void SCR_BaseEditorComponent::EOnEditorInitServer ( )
protected

When the entity is created (called on server).

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorOpen()

void SCR_BaseEditorComponent::EOnEditorOpen ( )
protected

When the editor is opened.

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorOpenServer()

void SCR_BaseEditorComponent::EOnEditorOpenServer ( )
protected

When the editor is opened (called on server).

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorOpenServerCallback()

void SCR_BaseEditorComponent::EOnEditorOpenServerCallback ( )
protected

When the editor is opened (called on server after async loading finished on client).

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorPostActivate()

void SCR_BaseEditorComponent::EOnEditorPostActivate ( )
protected

When the component is activated, but after EOnEditorActivate() function was called in all components.

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorPostDeactivate()

void SCR_BaseEditorComponent::EOnEditorPostDeactivate ( )
protected

When the component is deactivated, but after the next mode is activated.

Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorPreActivate()

void SCR_BaseEditorComponent::EOnEditorPreActivate ( )
protected

Before the component is activated.

  • When attached on SCR_EditorManagerEntity, this is executed together with EOnEditorOpen()
  • When attached on SCR_EditorModeEntity, it's executed before previous mode is deactivated, so values can be read from it
Examples
F:/Games/AReforger/scripts/Game/Editor/Components/Editor/SCR_TestEditorComponent.c.

◆ EOnEditorRequest()

void SCR_BaseEditorComponent::EOnEditorRequest ( bool isOpen)
protected

When opening/closing request is sent to server.

◆ EOnEffect()

void SCR_BaseEditorComponent::EOnEffect ( SCR_BaseEditorEffect effect)
protected

When an effect is created in reaction an an event.

◆ FindEditorComponent()

SCR_BaseEditorComponent SCR_BaseEditorComponent::FindEditorComponent ( typename type ,
bool showError = false,
bool modeFirst = false )
inlineprotected

Get the editor manager to which this component belongs.

Parameters
[in]type
[in]showError
[in]modeFirst
Returns
Editor manager

Definition at line 477 of file SCR_BaseEditorComponent.c.

◆ GetAllInstances()

int SCR_BaseEditorComponent::GetAllInstances ( typename type ,
out notnull array< Managed > outComponents )
inlinestaticprotected

Get component instances on editor manager (SCR_EditorBaseEntity) and all its modes (SCR_EditorModeEntity).

Parameters
[in]typeRequested component type
[out]outComponentsArray to be filled with components
Returns
Number of found components

Definition at line 433 of file SCR_BaseEditorComponent.c.

◆ GetEditorComponentData()

EntityComponentPrefabData SCR_BaseEditorComponent::GetEditorComponentData ( )
inlineprotected

Get prefab data of this component.

Returns
Prefab data

Definition at line 516 of file SCR_BaseEditorComponent.c.

◆ GetInstance() [1/2]

Managed SCR_BaseEditorComponent::GetInstance ( SCR_EditorBaseEntity editorManager,
typename type ,
bool showError = false )
inlinestaticprotected

Get instance of a component attached on specific editor manager / mode (SCR_EditorBaseEntity). When not found on editor manager, it will be searched for in current editor mode (SCR_EditorModeEntity).

Parameters
[in]editorManagerEditor manager or mode which is searched
[in]typeRequested component type
[in]showErrorTrue to log a warning message when the component was not found (useful when the component is required by a script)
Returns
Component

Definition at line 411 of file SCR_BaseEditorComponent.c.

◆ GetInstance() [2/2]

Managed SCR_BaseEditorComponent::GetInstance ( typename type ,
bool showError = false,
bool modeFirst = false )
inlinestaticprotected

Get the local instance of a component attached on editor manager (SCR_EditorManagerEntity). When not found on editor manager, it will be searched for in current editor mode (SCR_EditorModeEntity).

Parameters
[in]typeRequested component type
[in]showErrorTrue to log a warning message when the component was not found
[in]modeFirstWhen true, search the component first on editor mode and then on editor manager. By default it's false, the other way around.
Returns
Component

Definition at line 368 of file SCR_BaseEditorComponent.c.

◆ GetManager()

SCR_EditorManagerEntity SCR_BaseEditorComponent::GetManager ( )
inlineprotected

Get editor manager this component belongs to.

Returns
Editor manager

Definition at line 459 of file SCR_BaseEditorComponent.c.

◆ GetOnEffect()

ScriptInvoker SCR_BaseEditorComponent::GetOnEffect ( )
inlineprotected

Get event called when an effect is activated.

Returns
Script invoker

Definition at line 542 of file SCR_BaseEditorComponent.c.

◆ GetParentComponent()

SCR_BaseEditorComponent SCR_BaseEditorComponent::GetParentComponent ( )
inlineprotected

Definition at line 582 of file SCR_BaseEditorComponent.c.

◆ InitOwner()

void SCR_BaseEditorComponent::InitOwner ( )
inlineprotected

Definition at line 638 of file SCR_BaseEditorComponent.c.

◆ InitServer()

void SCR_BaseEditorComponent::InitServer ( )
inlineprotected

Definition at line 606 of file SCR_BaseEditorComponent.c.

◆ IsAdmin()

bool SCR_BaseEditorComponent::IsAdmin ( )
inlineprotected

Definition at line 575 of file SCR_BaseEditorComponent.c.

◆ IsMaster()

bool SCR_BaseEditorComponent::IsMaster ( )
inlineprotected

Definition at line 569 of file SCR_BaseEditorComponent.c.

◆ IsOnEditorManager()

bool SCR_BaseEditorComponent::IsOnEditorManager ( )
inlineprotected

Definition at line 551 of file SCR_BaseEditorComponent.c.

◆ IsOwner()

bool SCR_BaseEditorComponent::IsOwner ( )
inlineprotected

Definition at line 557 of file SCR_BaseEditorComponent.c.

◆ IsProxy()

bool SCR_BaseEditorComponent::IsProxy ( )
inlineprotected

Definition at line 563 of file SCR_BaseEditorComponent.c.

◆ IsRemoved()

bool SCR_BaseEditorComponent::IsRemoved ( )
inlineprotected

Check if the component is being deleted.

Returns
True if entity is ready to be deleted

Definition at line 528 of file SCR_BaseEditorComponent.c.

◆ OnActivateAsyncBase()

sealed bool SCR_BaseEditorComponent::OnActivateAsyncBase ( int attempt)
inlineprotected
Parameters
[in]attempt
Returns

Definition at line 304 of file SCR_BaseEditorComponent.c.

◆ OnActivateBase()

sealed void SCR_BaseEditorComponent::OnActivateBase ( )
inlineprotected

Definition at line 294 of file SCR_BaseEditorComponent.c.

◆ OnClosedBase()

sealed void SCR_BaseEditorComponent::OnClosedBase ( )
inlineprotected

Definition at line 280 of file SCR_BaseEditorComponent.c.

◆ OnDeactivateAsyncBase()

sealed bool SCR_BaseEditorComponent::OnDeactivateAsyncBase ( int attempt)
inlineprotected
Parameters
[in]attempt
Returns

Definition at line 345 of file SCR_BaseEditorComponent.c.

◆ OnDeactivateBase()

sealed void SCR_BaseEditorComponent::OnDeactivateBase ( )
inlineprotected

Definition at line 320 of file SCR_BaseEditorComponent.c.

◆ OnDeleteBase()

sealed void SCR_BaseEditorComponent::OnDeleteBase ( )
inlineprotected

Definition at line 260 of file SCR_BaseEditorComponent.c.

◆ OnEffectBase()

sealed void SCR_BaseEditorComponent::OnEffectBase ( SCR_BaseEditorEffect effect)
inlineprotected
Parameters
[in]effect

Definition at line 352 of file SCR_BaseEditorComponent.c.

◆ OnInitBase()

sealed void SCR_BaseEditorComponent::OnInitBase ( )
inlineprotected

Definition at line 254 of file SCR_BaseEditorComponent.c.

◆ OnOpenedBase()

sealed void SCR_BaseEditorComponent::OnOpenedBase ( )
inlineprotected

Definition at line 273 of file SCR_BaseEditorComponent.c.

◆ OnPostActivateBase()

sealed void SCR_BaseEditorComponent::OnPostActivateBase ( )
inlineprotected

Definition at line 310 of file SCR_BaseEditorComponent.c.

◆ OnPostDeactivateBase()

sealed void SCR_BaseEditorComponent::OnPostDeactivateBase ( )
inlineprotected

Definition at line 337 of file SCR_BaseEditorComponent.c.

◆ OnPostInit()

override void SCR_BaseEditorComponent::OnPostInit ( IEntity owner)
inlineprotected

Definition at line 670 of file SCR_BaseEditorComponent.c.

◆ OnPreActivateBase()

sealed void SCR_BaseEditorComponent::OnPreActivateBase ( )
inlineprotected

Definition at line 288 of file SCR_BaseEditorComponent.c.

◆ OnRequestBase()

sealed void SCR_BaseEditorComponent::OnRequestBase ( bool isOpen)
inlineprotected
Parameters
[in]isOpen

Definition at line 267 of file SCR_BaseEditorComponent.c.

◆ ResetEditorComponent()

void SCR_BaseEditorComponent::ResetEditorComponent ( )
protected

Reset values controlled by the component. To be overridden by child classes.

◆ SendNotification()

void SCR_BaseEditorComponent::SendNotification ( ENotification notificationID,
int selfID = 0,
int targetID = 0,
vector position = vector.Zero )
inlineprotected

Definition at line 598 of file SCR_BaseEditorComponent.c.

◆ SetParentComponent()

void SCR_BaseEditorComponent::SetParentComponent ( SCR_BaseEditorComponent parent)
inlineprotected

Definition at line 588 of file SCR_BaseEditorComponent.c.

Member Data Documentation

◆ m_Manager

SCR_EditorManagerEntity SCR_BaseEditorComponent::m_Manager
protected

Definition at line 122 of file SCR_BaseEditorComponent.c.

◆ m_Owner

SCR_EditorBaseEntity SCR_BaseEditorComponent::m_Owner
protected

Definition at line 121 of file SCR_BaseEditorComponent.c.

◆ m_Parent

SCR_BaseEditorComponent SCR_BaseEditorComponent::m_Parent
protected

Definition at line 123 of file SCR_BaseEditorComponent.c.

◆ m_RplComponent

RplComponent SCR_BaseEditorComponent::m_RplComponent
protected

Definition at line 124 of file SCR_BaseEditorComponent.c.

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