Arma Reforger Script API
|
Public Member Functions | |
override void | EOnEditorInit () |
When the entity is created. | |
override void | EOnEditorDelete () |
When the entity is destroyed. | |
override void | EOnEditorRequest (bool isOpen) |
When opening/closing request is sent to server. | |
override void | EOnEditorOpen () |
When the editor is opened. | |
override void | EOnEditorClose () |
When the editor is closed. | |
override void | EOnEditorPreActivate () |
Before the component is activated. | |
override void | EOnEditorActivate () |
When the component is activated. | |
override bool | EOnEditorActivateAsync (int attempt) |
When the component is activated. | |
override void | EOnEditorPostActivate () |
When the component is activated, but after EOnEditorActivate() function was called in all components. | |
override void | EOnEditorDeactivate () |
When the component is deactivated. | |
override bool | EOnEditorDeactivateAsync (int attempt) |
When the component is deactivated. | |
override void | EOnEditorPostDeactivate () |
When the component is deactivated, but after the next mode is activated. | |
override void | EOnEditorDebug (array< string > debugTexts) |
Every frame while the editor is opened and debug menu is shown. | |
override void | EOnEffect (SCR_BaseEditorEffect effect) |
When an effect is created in reaction an an event. | |
override void | EOnEditorInitServer () |
When the entity is created (called on server) | |
override void | EOnEditorDeleteServer () |
When the entity is destroyed (called on server) | |
override void | EOnEditorOpenServer () |
When the editor is opened (called on server) | |
override void | EOnEditorOpenServerCallback () |
When the editor is opened (called on server after async loading finished on client) | |
override void | EOnEditorCloseServer () |
When the editor is closed (called on server) | |
override void | EOnEditorCloseServerCallback () |
When the editor is closed (called on server after async loading finished on client) | |
override void | EOnEditorActivateServer () |
When the component is activated (called on server) | |
override void | EOnEditorDeactivateServer () |
When the component is deactivated (called on server) | |
Public Member Functions inherited from SCR_BaseEditorComponent | |
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 () |
Get editor manager this component belongs to. | |
SCR_BaseEditorComponent | FindEditorComponent (TypeName type, bool showError=false, bool modeFirst=false) |
Get the editor manager to which this component belongs. | |
EntityComponentPrefabData | GetEditorComponentData () |
Get prefab data of this component. | |
bool | IsRemoved () |
Check if the component is being deleted. | |
void | ResetEditorComponent () |
Reset values controlled by the component. | |
ScriptInvoker | GetOnEffect () |
Get event called when an effect is activated. | |
void | InitServer () |
void | InitOwner () |
override void | OnPostInit (IEntity owner) |
void | SCR_BaseEditorComponent (IEntityComponentSource src, IEntity ent, IEntity parent) |
void | ~SCR_BaseEditorComponent () |
Additional Inherited Members | |
Static Public Member Functions inherited from SCR_BaseEditorComponent | |
static Managed | GetInstance (TypeName type, bool showError=false, bool modeFirst=false) |
Get the local instance of a component attached on editor manager (SCR_EditorManagerEntity). | |
static Managed | GetInstance (SCR_EditorBaseEntity editorManager, TypeName type, bool showError=false) |
Get instance of a component attached on specific editor manager / mode (SCR_EditorBaseEntity). | |
static int | GetAllInstances (TypeName type, out notnull array< Managed > outComponents) |
Get component instances on editor manager (SCR_EditorBaseEntity) and all its modes (SCR_EditorModeEntity). | |
Protected Member Functions inherited from SCR_BaseEditorComponent | |
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) |
Protected Attributes inherited from SCR_BaseEditorComponent | |
SCR_EditorBaseEntity | m_Owner |
SCR_EditorManagerEntity | m_Manager |
SCR_BaseEditorComponent | m_Parent |
RplComponent | m_RplComponent |
override void SCR_TestEditorComponent.EOnEditorActivate | ( | ) |
When the component is activated.
Implements SCR_BaseEditorComponent.
override bool SCR_TestEditorComponent.EOnEditorActivateAsync | ( | int | attempt | ) |
When the component is activated.
Asynchronous, can take multiple frames in case of complex operations.
[in] | attempt | Number of previous attempts to activate the component. |
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorActivateServer | ( | ) |
When the component is activated (called on server)
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorClose | ( | ) |
When the editor is closed.
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorCloseServer | ( | ) |
When the editor is closed (called on server)
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorCloseServerCallback | ( | ) |
When the editor is closed (called on server after async loading finished on client)
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorDeactivate | ( | ) |
When the component is deactivated.
Implements SCR_BaseEditorComponent.
override bool SCR_TestEditorComponent.EOnEditorDeactivateAsync | ( | int | attempt | ) |
When the component is deactivated.
Asynchronous, can take multiple frames in case of complex operations.
[in] | attempt | Number of previous attempts to deactivate the component. |
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorDeactivateServer | ( | ) |
When the component is deactivated (called on server)
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorDebug | ( | array< string > | debugTexts | ) |
Every frame while the editor is opened and debug menu is shown.
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorDelete | ( | ) |
When the entity is destroyed.
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorDeleteServer | ( | ) |
When the entity is destroyed (called on server)
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorInit | ( | ) |
When the entity is created.
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorInitServer | ( | ) |
When the entity is created (called on server)
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorOpen | ( | ) |
When the editor is opened.
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorOpenServer | ( | ) |
When the editor is opened (called on server)
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorOpenServerCallback | ( | ) |
When the editor is opened (called on server after async loading finished on client)
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorPostActivate | ( | ) |
When the component is activated, but after EOnEditorActivate() function was called in all components.
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorPostDeactivate | ( | ) |
When the component is deactivated, but after the next mode is activated.
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorPreActivate | ( | ) |
Before the component is activated.
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEditorRequest | ( | bool | isOpen | ) |
When opening/closing request is sent to server.
Implements SCR_BaseEditorComponent.
override void SCR_TestEditorComponent.EOnEffect | ( | SCR_BaseEditorEffect | effect | ) |
When an effect is created in reaction an an event.
Implements SCR_BaseEditorComponent.