list: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(eg 2 (thislist))
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
(32 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
| ofp


|1.00|= Game version
|1.00


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


| List of units that would activate given [[Triggers|Trigger]].
| List of units that would activate given [[Triggers|Trigger]].


It returns nothing before the simulation strted, i.e. in (undelayed) init.sqf files or in VBS OME. 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).
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 second example can be used inside the trigger (in that case, no need to name your trigger).


For trigger of type "Not present" the list is the same as that returned for "present". |= Description
The list returned for trigger of type "Not present" is the same as that returned for type "present".  
____________________________________________________________________________________________


|[[Array]] <nowiki>=</nowiki>  '''list''' trigger |= Syntax
'''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.


|p1= trigger: [[Object]] |= Parameter 1
|[[Array]] <nowiki>=</nowiki>  '''list''' trigger


| [[Array]] or [[Nothing]] |= Return value
|p1= trigger: [[Object]]
____________________________________________________________________________________________
 
| [[Array]] or [[Nothing]]
   
   
|x1= <code>_tlist <nowiki>=</nowiki> '''list''' _triggerOne; </code>|= Example 1
|x1= <code>_tlist <nowiki>=</nowiki> '''list''' _triggerOne; </code>
|x2= <code>hint format ["%1", '''thislist''']; </code>|= Example 2
|x2= <code>[[hint]] [[format]] ["%1", [[thisList]]]; </code>
____________________________________________________________________________________________
 
|  |= See also


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


<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on March 6, 2013 - 14:15 (CEST)</dd>
<dt class="note">[[User:TeaCup|teaCup]]</dt>
<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>


<h3 style="display:none">Bottom Section</h3>
 
[[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]]
{{GameCategory|arma1|Scripting Commands}}
[[Category:Command Group: Activators|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma2|Scripting Commands}}
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
<!-- 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 -->

Revision as of 00:53, 17 February 2021

Game1 needed - Version1 needed
GAGlobalLELocal
Hover & click on the images for description

Description

Description:
This article is a Stub. You can help BI Community Wiki by expanding it.
Description needed
Groups:
Triggers

Syntax

Syntax:
Syntax needed
Parameters:
trigger: Object
Return Value:
Return value needed

Examples

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

Additional Information

See also:
setTriggerActivationcreateTriggerthisList

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
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=247332"