BIS fnc addScriptedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(some of the names)
mNo edit summary
Line 24: Line 24:
* EndGame_OnStageChanged
* EndGame_OnStageChanged
* EndGame_OnStartGameObjectiveCompleted
* EndGame_OnStartGameObjectiveCompleted
* FlagAnimationDone
* garageClosed
* garageClosed
* garageOpened
* garageOpened

Revision as of 19:15, 12 December 2016


Hover & click on the images for description

Description

Description:
Adds scripted event handler and returns id. "ScriptedEventHandlerAdded" scripted EH is called. Some of the Scripted EH names used in various scripts and modules:
  • arsenalClosed
  • arsenalOpened
  • BIS_fnc_playVideo_stopped
  • bis_groundSupport_groupSpawned
  • curatorObjectPlaced
  • curatorObjectRemoteControlled
  • curatorUnitAssigned
  • dominantSideChanged
  • EGSpectator_OnCameraModeChanged
  • EndGame_Ended
  • EndGame_OnObjectiveCompleted
  • EndGame_OnObjectiveEnded
  • EndGame_OnObjectiveStateChanged
  • EndGame_OnStageChanged
  • EndGame_OnStartGameObjectiveCompleted
  • FlagAnimationDone
  • garageClosed
  • garageOpened
  • intelObjectFound
  • ownerChanged
  • respawn
  • respawnTicketsExhausted
  • RscDisplayEGSpectator_MapStateChanged
  • RscDisplayEGSpectator_OnCursorObjectFocused
  • RscDisplayEGSpectator_OnCursorObjectUnfocused
  • RscDisplayEGSpectator_OnFocusChanged
  • RscDisplayEGSpectator_OnUiVisibilityChanged
  • RscDisplayRespawnKeyDown
  • ScriptedEventHandlerAdded
  • ScriptedEventHandlerRemoved
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[namespace, name, code] call BIS_fnc_addScriptedEventHandler;
Parameters:
namespace: Namespace, Object, Group, Location, Boolean, Control or Display - namespace in which handler is saved
name: String - handler name
code: Code or String - code executed upon calling
Return Value:
Number - id of the currently added event handler

Examples

Example 1:
[missionNamespace, "event", {hint "Hello World"}] call BIS_fnc_addScriptedEventHandler;
Example 2:
[true, "event", {hint "Hello World"}] call BIS_fnc_addScriptedEventHandler; Boolean will default to missionNamespace

Additional Information

See also:
BIS_fnc_callScriptedEventHandlerBIS_fnc_removeScriptedEventHandlerBIS_fnc_removeAllScriptedEventHandlers

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Notes

Bottom Section