Event Handlers – Arma Reforger
Jump to navigation
Jump to search
Lou Montana (talk | contribs) (Add Script Invoker guidelines) |
Lou Montana (talk | contribs) (Add HHMMSS, Fix dupe) |
||
(10 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
__NOEDITSECTION__{{TOC|side}} | __NOEDITSECTION__ | ||
= | {{TOC|side}} | ||
{{TOC|subtoc|content= | |||
* 1 {{Link|#Script Invokers}} | |||
* 2 {{Link|#Event Handler Manager Component Events}} | |||
* 3 {{Link|#Entity Event Handlers}} | |||
}} | |||
== Script Invokers == | |||
* An Event Handler can be created using a '''{{Link|enfusion://ScriptEditor/scripts/Game/Helpers/SCR_ScriptInvokerHelper.c|ScriptInvoker}}''' class. | |||
* Any Script Invoker signature can be created using {{hl|{{Link|Arma Reforger:Scripting: Keywords#typedef|typedef}}}} - see {{Link|Arma Reforger:ScriptInvoker Usage#Signature Declaration}}. | |||
* Using the {{Link/Enfusion|armaR|ScriptInvoker}} class itself is considered bad practice and '''must''' be avoided. | |||
* As Script Invokers are big objects and can be numerous, it is good practice to '''not''' instanciate them by default but to rather create them on request, using their getter - saving memory. | |||
{{Feature|informative| | {{Feature|informative| | ||
See {{Link|Arma Reforger:ScriptInvoker Usage}} and its {{Link|Arma Reforger:ScriptInvoker Usage#Signature Declaration|Signature Declaration}} section for tutorials on how to use Script Invokers. | |||
}} | }} | ||
== | == Event Handler Manager Component Events == | ||
{{ | The {{Link/Enfusion|armaR|EventHandlerManagerComponent}} groups the following events under its category: | ||
{| class="wikitable sortable valign | {| class="wikitable sortable valign="top" | ||
! Event | |||
! Class | ! Class | ||
! class="unsortable | Description | |||
! class="unsortable | |||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
=== | === OnADSChanged === | ||
| {{Link/Enfusion|armaR| | | rowspan="3" | {{Link/Enfusion|armaR|CharacterControllerComponent}} | ||
| | | | ||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
=== | === OnConsciousnessChanged === | ||
| | | | ||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
Line 56: | Line 45: | ||
=== OnMagazineCountChanged === | === OnMagazineCountChanged === | ||
| {{Link/Enfusion|armaR|InventoryStorageManagerComponent}} | | {{Link/Enfusion|armaR|InventoryStorageManagerComponent}} | ||
| | |||
|- | |||
| style="font-size: 0.8em" | | |||
=== OnDestroyed === | |||
| {{Link/Enfusion|armaR|DamageManagerComponent}} | |||
| when the default hit zone is set to destroyed | |||
|- | |||
| style="font-size: 0.8em" | | |||
=== OnCompartmentEntering === | |||
| rowspan="4" | {{Link/Enfusion|armaR|BaseCompartmentManagerComponent}} | |||
| | | | ||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
=== OnCompartmentEntered === | === OnCompartmentEntered === | ||
| | | | ||
|- | |- | ||
Line 68: | Line 66: | ||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
=== | === OnCompartmentLeaving === | ||
| {{Link/Enfusion|armaR| | | | ||
| | |- | ||
| style="font-size: 0.8em" | | |||
=== OnLightStateChanged === | |||
| {{Link/Enfusion|armaR|BaseLightManagerComponent}} | |||
| | |||
|- | |||
| style="font-size: 0.8em" | | |||
=== OnTurretReload === | |||
| rowspan="2" | {{Link/Enfusion|armaR|TurretControllerComponent}} | |||
| {{hl|isFinished}} is true when reload is done and false when it started | |||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
=== | === OnADSChanged === | ||
| | | on player character which switches to ADS<br>{{Link/Enfusion|armaR|TurretControllerComponent}} can also trigger this event | ||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
=== OnWeaponChanged === | === OnWeaponChanged === | ||
| {{Link/Enfusion|armaR|BaseWeaponManagerComponent}} | |||
| | |||
|- | |||
| style="font-size: 0.8em" | | |||
=== OnMuzzleChanged === | |||
| {{Link/Enfusion|armaR|BaseWeaponComponent}} | |||
| | | | ||
|- | |||
| style="font-size: 0.8em" | | |||
=== OnAmmoCountChanged === | |||
| rowspan="4" | {{Link/Enfusion|armaR|BaseMuzzleComponent}} | |||
| Both weapon and character can raise this event (see {{hl|BaseWeaponManagerComponent}}) | |||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
Line 86: | Line 103: | ||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
=== | === OnProjectileShot === | ||
| | | | ||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
=== OnFiremodeChanged === | === OnFiremodeChanged === | ||
| | | | ||
|- | |||
| style="font-size: 0.8em" | | |||
=== OnWeaponAttachmentChanged === | |||
| rowspan="2" | {{Link/Enfusion|armaR|WeaponComponent}} | |||
| {{hl|isAttached}} is true if {{hl|attachmentEntity}} was attached to the weapon, and false if it was detached | |||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
=== OnZeroingChanged === | === OnZeroingChanged === | ||
| currently does not carry currentMuzzle | | currently does not carry currentMuzzle | ||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
=== | === OnGrenadeThrown === | ||
| {{Link/Enfusion|armaR| | | {{Link/Enfusion|armaR|WeaponSlotComponent}} | ||
| {{hl| | | | ||
|- | |||
| style="font-size: 0.8em" | | |||
=== HHMMSS === | |||
| rowspan="3" | {{Link/Enfusion|armaR|TimeAndWeatherManagerEntity}} | |||
| Triggers based on {{Link/Enfusion|armaR|TimeAndWeatherManagerEntity}}'s {{hl|TIME_EVENT_PERIODICITY}} value: | |||
* 0: never | |||
* 1: every hour | |||
* 2: every minute | |||
* 3: every second | |||
|- | |||
| style="font-size: 0.8em" | | |||
=== OnDayStart === | |||
| | |||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
=== | === OnNightStart === | ||
| | | | ||
|} | |} | ||
Line 114: | Line 145: | ||
== Entity Event Handlers == | == Entity Event Handlers == | ||
{{Feature|informative|See also {{Link|Arma Reforger:Entity Lifecycle}}.}} | |||
The following events are present and available in the '''{{Link/Enfusion|armaR|IEntity}}''' class - read the code documentation to learn more about them and how to use them. | The following events are present and available in the '''{{Link/Enfusion|armaR|IEntity}}''' class - read the code documentation to learn more about them and how to use them. | ||
{{Feature|informative|'''E''' in e.g '''E'''OnInit stands for Event (not Entity).}} | {{Feature|informative|'''E''' in e.g '''E'''OnInit stands for Event (not Entity).}} | ||
Line 123: | Line 155: | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
=== EOnInit === | === EOnInit === | ||
| Event after the entity is allocated and | | Event after the entity is allocated and initialised. | ||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
Line 139: | Line 171: | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
=== EOnFixedFrame === | === EOnFixedFrame === | ||
| | | {{Feature|warning|This event can be called on another thread than the main thread. This means that you must avoid any modifications on other entities during this event!}} | ||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
Line 180: | Line 212: | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | | ||
=== EOnDiag === | === EOnDiag === | ||
| Happens every frame after {{Link|#EOnFrame}} when "Entity Diag" is enabled in the [[Arma Reforger:Diag Menu|Diag Menu]] (e.g | | Happens every frame after {{Link|#EOnFrame}} when "Entity Diag" is enabled in the [[Arma Reforger:Diag Menu|Diag Menu]] (e.g {{GameCategory|armaR|Modding|Official Tools|text= Workbench}}). | ||
|- | |- | ||
| style="font-size: 0.8em" | | | style="font-size: 0.8em" | |
Latest revision as of 12:54, 2 September 2024
Script Invokers
- An Event Handler can be created using a ScriptInvoker class.
- Any Script Invoker signature can be created using typedef - see ScriptInvoker Usage - Signature Declaration.
- Using the ScriptInvoker class itself is considered bad practice and must be avoided.
- As Script Invokers are big objects and can be numerous, it is good practice to not instanciate them by default but to rather create them on request, using their getter - saving memory.
Event Handler Manager Component Events
The EventHandlerManagerComponent groups the following events under its category:
Event | Class | Description |
---|---|---|
OnADSChanged |
CharacterControllerComponent | |
OnConsciousnessChanged |
||
OnInspectionModeChanged |
on player character which switches in/out of inspection mode | |
OnMagazineCountChanged |
InventoryStorageManagerComponent | |
OnDestroyed |
DamageManagerComponent | when the default hit zone is set to destroyed |
OnCompartmentEntering |
BaseCompartmentManagerComponent | |
OnCompartmentEntered |
||
OnCompartmentLeft |
||
OnCompartmentLeaving |
||
OnLightStateChanged |
BaseLightManagerComponent | |
OnTurretReload |
TurretControllerComponent | isFinished is true when reload is done and false when it started |
OnADSChanged |
on player character which switches to ADS TurretControllerComponent can also trigger this event | |
OnWeaponChanged |
BaseWeaponManagerComponent | |
OnMuzzleChanged |
BaseWeaponComponent | |
OnAmmoCountChanged |
BaseMuzzleComponent | Both weapon and character can raise this event (see BaseWeaponManagerComponent) |
OnMagazineChanged |
||
OnProjectileShot |
||
OnFiremodeChanged |
||
OnWeaponAttachmentChanged |
WeaponComponent | isAttached is true if attachmentEntity was attached to the weapon, and false if it was detached |
OnZeroingChanged |
currently does not carry currentMuzzle | |
OnGrenadeThrown |
WeaponSlotComponent | |
HHMMSS |
TimeAndWeatherManagerEntity | Triggers based on TimeAndWeatherManagerEntity's TIME_EVENT_PERIODICITY value:
|
OnDayStart |
||
OnNightStart |
Entity Event Handlers
The following events are present and available in the IEntity class - read the code documentation to learn more about them and how to use them.
Event | Description |
---|---|
EOnInit |
Event after the entity is allocated and initialised. |
EOnVisible |
This event triggers when the entity is made visible (versus being invisible). |
EOnFrame |
This event, as its name suggests, triggers on each simulation frame. |
EOnPostFrame |
Triggers after physics update. |
EOnFixedFrame |
|
EOnFixedPostFrame |
|
EOnAnimEvent |
Event from the animation system |
EOnPhysicsActive |
Triggers on (de)activation of the RigidBody's physics. |
EOnPhysicsMove |
Triggers when the physics engine moves this entity. |
EOnSimulate |
Happens before physics engine iteration - called from sub-iterations. |
EOnPostSimulate |
Happens after physics engine iteration. Happens once per frame. |
EOnJointBreak |
Triggers when a joint attached to this entity's RigidBody is broken. |
EOnTouch |
Event when touched by another entity. It requires the entity to have TouchComponent. |
EOnContact |
Triggers when contact with another RigidBody has been registered. |
EOnDiag |
Happens every frame after EOnFrame when "Entity Diag" is enabled in the Diag Menu (e.g Workbench). |
EOnUser0 |
|
EOnUser1 |
|
EOnUser2 |
|
EOnUser3 |
|
EOnUser4 |