Difference between revisions of "list"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Text replacement - " {2,}\}\}" to " }}")
 
(52 intermediate revisions by 19 users not shown)
Line 1: Line 1:
−
[[Category:Scripting Commands|LIST]]
+
{{Command
−
[[Category:Scripting Commands OFP 1.97|LIST]]
+
 
−
[[Category:Scripting Commands OFP 1.46|LIST]]
+
| ofp
−
[[Category:Scripting Commands ArmA|LIST]]
+
 
 +
|1.00
 +
 
 +
|arg= global
 +
|eff= local |= Effect in MP
 +
 
 +
|gr1= Triggers
 +
 
 +
| 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).
  
−
<h2 style="color:#000066"> '''list ''trigger'''''</h2>
+
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".
  
−
'''Operand types:'''
+
'''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.
  
−
'''trigger:''' [[Object]]
+
|[[Array]] <nowiki>=</nowiki>  '''list''' trigger
  
−
'''Type of returned value:'''
+
|p1= trigger: [[Object]]
  
−
[[Array]]
+
| [[Array]] or [[Nothing]]
 +
 
 +
|x1= <code>_tlist <nowiki>=</nowiki> '''list''' _triggerOne; </code>
 +
|x2= <code>[[hint]] [[format]] ["%1", [[thisList]]]; </code>
  
−
'''Description:'''
+
| [[setTriggerActivation]], [[createTrigger]], [[thisList]]
 +
}}
  
−
List of units that would activate given '''trigger'''.
+
<dl class="command_description">
 +
<!-- Note Section BEGIN -->
  
−
For trigger of type "Not present" the list is the same as that returned for "present".
+
<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 -->
 +
</dl>
  
−
'''Example:'''
+
[[Category:Scripting Commands|LIST]]
 +
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands OFP 1.96|LIST]]
 +
[[Category:Scripting Commands OFP 1.46|LIST]]
 +
{{GameCategory|arma1|Scripting Commands}}
 +
{{GameCategory|arma2|Scripting Commands}}
 +
{{GameCategory|arma3|Scripting Commands}}
 +
{{GameCategory|tkoh|Scripting Commands}}
  
−
_tlist = '''list''' triggerOne
+
<!-- CONTINUE Notes -->
 +
<dl class="command_description">
 +
<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: {{Inline code|Error Reserved variable in expression}}.
 +
</dd>
 +
</dl>
 +
<!-- DISCONTINUE Notes -->

Latest revision as of 00:21, 19 January 2021

Introduced with Operation Flashpoint version 1.001.00Arguments of this scripting command don't have to be local to the client the command is executed onEffects of this scripting command are not broadcasted over the network and remain local to the client the command is executed on
Hover & click on the images for descriptions

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.

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:
setTriggerActivationcreateTriggerthisList
Groups:
Triggers

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

+ Add Note (Help)

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.
Posted on January 6, 2021 - 01:58 (UTC)
7erra
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=218311"