list: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2")
m (Some wiki formatting)
 
(5 intermediate revisions by the same user not shown)
Line 29: Line 29:
|descr= List of units that would activate given [[Triggers|Trigger]].
|descr= List of units that would activate given [[Triggers|Trigger]].


It returns nothing before the simulation started, i.e. in (undelayed) init.sqf files. Returns a '''[[Array#Array_references|pointer]]''' to the trigger's list after the simulation started.<br>Since this is just a ''reference'' this means that the value in your local variable will change as the content of the trigger area changes. To permanently copy the returned list to a different variable, use {{ic|_mylist {{=}} +([[list]] triggerOne)}}.
It returns nothing before the simulation started, i.e. in (undelayed) init.sqf files. Returns a '''[[Array#Array properties|pointer]]''' to the trigger's list after the simulation started.<br>
Since this is just a ''reference'' this means that the value in your local variable will change as the content of the trigger area changes.
To permanently copy the returned list to a different variable, use <sqf inline>_mylist = +(list triggerOne)</sqf>.


The second example can be used inside the trigger (in that case, no need to name your trigger).
The second example can be used inside the trigger (in that case, no need to name your trigger).
Line 43: Line 45:
|r1= [[Array]] or [[Nothing]]
|r1= [[Array]] or [[Nothing]]


|x1= <code>_triggerList = [[list]] _triggerOne;</code>
|x1= <sqf>_triggerList = list _triggerOne;</sqf>


|x2= <code>[[hint]] [[format]] ["%1", [[thisList]]];</code>
|x2= <sqf>hint format ["%1", thisList];</sqf>


|seealso= [[setTriggerActivation]] [[createTrigger]] [[thisList]]
|seealso= [[setTriggerActivation]] [[createTrigger]] [[thisList]]
}}
}}


<dl class="command_description">
{{Note
|user= TeaCup
|timestamp= 20130306141500
|text= Calling [[list]] immediately after creating a trigger via [[createTrigger]] (and setting up activation, area, statements, timeout, etc..), will return {{hl|<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.
}}


<dt><dt>
{{Note
<dd class="notedate">Posted on March 6, 2013 - 14:15 (CEST)</dd>
|user= 7erra
<dt class="note">[[User:TeaCup|teaCup]]</dt>
|timestamp= 20210106015800
<dd class="note">Calling [[list]] immediately after creating a trigger via [[createTrigger]] (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.
|text= The resulting array is not modifiable. Any [[:Category:Command_Group:_Arrays|array related commands]], that modify the original array, will fail with the error message: {{hl|Error Reserved variable in expression}}.
</dd>
}}
 
<dt></dt>
<dd class="notedate">Posted on January 6, 2021 - 01:58 (UTC)</dd>
<dt class="note">[[User:7erra|7erra]]</dt>
<dd class="note">
The resulting array is not modifiable. Any [[:Category:Command_Group:_Arrays|array related commands]], that modify the original array, will fail with the error message: {{ic|Error Reserved variable in expression}}.
</dd>
 
</dl>

Latest revision as of 15:51, 12 July 2022

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobalLELocal
Hover & click on the images for description

Description

Description:
List of units that would activate given Trigger. It returns nothing before the simulation started, i.e. in (undelayed) init.sqf files. Returns a pointer to the trigger's list after the simulation started.
Since this is just a reference this means that the value in your local variable will change as the content of the trigger area changes. To permanently copy the returned list to a different variable, use _mylist = +(list triggerOne). The second example can be used inside the trigger (in that case, no need to name your trigger). The list returned for trigger of type "Not present" is the same as that returned for type "present".
⚠
While the command can query any trigger, local or remote, the result will be only for the trigger condition set on the local client. See createTrigger for more info.
Groups:
Triggers

Syntax

Syntax:
list trigger
Parameters:
trigger: Object
Return Value:
Array or Nothing

Examples

Example 1:
_triggerList = list _triggerOne;
Example 2:
hint format ["%1", thisList];

Additional Information

See also:
setTriggerActivation createTrigger thisList

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
TeaCup - c
Posted on Mar 06, 2013 - 14:15 (UTC)
Calling list immediately after creating a trigger via createTrigger (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.
7erra - c
Posted on Jan 06, 2021 - 01:58 (UTC)
The resulting array is not modifiable. Any array related commands, that modify the original array, will fail with the error message: Error Reserved variable in expression.
Retrieved from "https://community.bistudio.com/wiki?title=list&oldid=325333"