createTrigger: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(description format)
(alt syntax)
Line 5: Line 5:


|1.00|= Game version
|1.00|= Game version
 
|eff= global|=
|eff= global |= Effects in MP
____________________________________________________________________________________________
____________________________________________________________________________________________


| Creates a sensor ([[trigger]]) of the given type and at the given position. The type must be a class name in CfgNonAIVehicles or CfgVehicles with simulation <nowiki>=</nowiki> detector. An array containing all units that have activated the trigger is available via [[list]] ''triggerobj''. Created triggers can be deleted using [[deleteVehicle]].<br><br>
| Creates a sensor ([[trigger]]) of the given type and at the given position. The type must be a class name in CfgNonAIVehicles or CfgVehicles with simulation <nowiki>=</nowiki> detector. An array containing all units that have activated the trigger is available via [[list]] ''triggerobj''. Created triggers can be deleted using [[deleteVehicle]].<br><br>


'''NOTE:''' Triggers in multiplayer are global objects and therefore should only be created on the server. Creating trigger on a client will result in trigger becoming a dead weight transferred to the server when client logs out. When created in the editor triggers are created on the server only, the trigger statements are then set on each client individually. After creating a trigger on the server, you can use [[setTriggerStatements]] and other setTriggerXXXX commands on each client to set the required client trigger operation individually.<br><br>
'''NOTE:''' Since Arma 3 v1.43.129935 triggers can be created locally on clients using the alternative syntax.<br><br>


Triggers are created with default params, which are:
Triggers are created with default params, which are:
Line 35: Line 34:
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''createTrigger''' [type, position] |= Syntax
| '''createTrigger''' [type, position]|= Syntax


|p1= [type, position]: [[Array]] |= Parameter 1
|p1= [type, position]: [[Array]] |= Parameter 1
Line 42: Line 41:


| [[Object]] |= Return value
| [[Object]] |= Return value
|s2= '''createTrigger''' [type, position, makeGlobal]&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;''(available since Arma 3 v1.43.129935)''|= Syntax
|p21= [type, position, makeGlobal]: [[Array]] |= Parameter 1
|p22= type: [[String]] |= Parameter 2
|p23= position: [[Position]] |= Parameter 3
|p24= makeGlobal: [[Boolean]] - locality flag, true - trigger is global {{EffArg|cmd|eff|glob}}, false - trigger is local {{EffArg|cmd|eff|local}} |= Parameter 3
| r2= [[Object]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   

Revision as of 18:36, 27 March 2015

-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

Description:
Creates a sensor (trigger) of the given type and at the given position. The type must be a class name in CfgNonAIVehicles or CfgVehicles with simulation = detector. An array containing all units that have activated the trigger is available via list triggerobj. Created triggers can be deleted using deleteVehicle.

NOTE: Since Arma 3 v1.43.129935 triggers can be created locally on clients using the alternative syntax.

Triggers are created with default params, which are:
  • a - 50.0
  • b - 50.0
  • angle - 0
  • rectangular - false
  • activationBy - None
  • activationType - Present
  • repeating - false
  • timeoutMin - 0
  • timeoutMid - 0
  • timeoutMax - 0
  • interruptable - true
  • type - None
  • text - ""
  • name - ""
  • expCond - "this"
  • expActiv - ""
  • expDesactiv - ""
Multiplayer:
Triggers are global and will be present on all machine(s) when this command is run.
Groups:
Uncategorised

Syntax

Syntax:
createTrigger [type, position]
Parameters:
[type, position]: Array
type: String
position: Position
Return Value:
Object

Alternative Syntax

Syntax:
createTrigger [type, position, makeGlobal]         (available since Arma 3 v1.43.129935)
Parameters:
[type, position, makeGlobal]: Array
type: String
position: Position
makeGlobal: Boolean - locality flag, true - trigger is global Template:EffArg, false - trigger is local Template:EffArg
Return Value:
Object

Examples

Example 1:
_trg = createTrigger ["EmptyDetector", getPos player]; _trg setTriggerArea [5, 5, 0, false]; _trg setTriggerActivation ["CIV", "PRESENT", true]; _trg setTriggerStatements ["this", "hint 'Civilian near player'", "hint 'no civilian near'"];

Additional Information

See also:
setTriggerActivationsetTriggerAreasetTriggerStatementssetTriggerTextsetTriggerTimeoutsetTriggerTypesetEffectConditionsetSoundEffectsetMusicEffectsetTitleEffectdeleteVehiclesynchronizeWaypointsynchronizeTrigger

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

Posted on March 6, 2013 - 14:15 (CEST)
teaCup
Calling list immediately after creating a trigger this way (and setting up activation, area, statements, timeout, etc..), will return <null> instead of an array. It seems the trigger needs about 1 second to initialise, after which it will behave as expected: returning an array of all the objects inside the trigger (the ones matching the criteria), or an empty array.

Bottom Section