list: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "\[\[Category\: ?Command[ _]Group\:.*\|\{\{uc\:\{\{PAGENAME\}\}\}\}\]\] " to "")
(33 intermediate revisions by 17 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| ofp |= Game name
| ofp |Game name=


|1.00|= Game version
|1.00|Game version=


|arg= global |= Arguments in MP
|arg= global |Multiplayer Arguments=
|eff= local |= Effect in MP
 
|gr1= Triggers |GROUP1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| List of units that would activate given trigger. For trigger of type "Not present" the list is the same as that returned for "present". |= Description
| 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 _mylist <nowiki>=</nowiki> +(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".
 
'''NOTE:''' 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. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''list''' |= Syntax
|[[Array]] <nowiki>=</nowiki>  '''list''' trigger |SYNTAX=


|p1= trigger: [[Object]] |= Parameter 1
|p1= trigger: [[Object]] |PARAMETER1=


| [[Array]] |= Return value
| [[Array]] or [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>_tlist = '''list''' triggerOne </code>|= Example 1
|x1= <code>_tlist <nowiki>=</nowiki> '''list''' _triggerOne; </code>|EXAMPLE1=
|x2= <code>hint format ["%1", '''thislist''']; </code>|EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[setTriggerActivation]], [[createTrigger]]|SEEALSO=


}}
}}
Line 29: Line 41:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
For local use in the trigger use thislist instead of list triggerOne.
 
<dd class="notedate">Posted on March 6, 2013 - 14:15 (CEST)
<dt class="note">[[User:TeaCup|teaCup]]
<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.
 
<!-- Note Section END -->
<!-- Note Section END -->
</dl>
</dl>
Line 35: Line 51:
<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|LIST]]
[[Category:Scripting Commands|LIST]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|LIST]]
[[Category:Scripting Commands OFP 1.96|LIST]]
[[Category:Scripting Commands OFP 1.46|LIST]]
[[Category:Scripting Commands OFP 1.46|LIST]]
[[Category:Scripting Commands ArmA|LIST]]
[[Category:Scripting Commands Armed Assault|LIST]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 12:02, 25 September 2020

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". NOTE: 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:
Array = list trigger
Parameters:
trigger: Object
Return Value:
Array or Nothing

Examples

Example 1:
_tlist = list _triggerOne;
Example 2:
hint format ["%1", thislist];

Additional Information

See also:
setTriggerActivationcreateTrigger

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 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.

Bottom Section