BIS fnc sceneAreaClearance: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added params, syntax, example.)
No edit summary
Line 41: Line 41:
[[Category:{{Name|tkoh}}: Functions|{{uc:sceneAreaClearance}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:sceneAreaClearance}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:sceneAreaClearance}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:sceneAreaClearance}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on October 2, 2014 - 16:29 (UTC)</dd>
<dt class="note">[[User:Tryteyker-|Tryteyker-]]</dt>
<dd class="note">
In regards to the 'safe position' where the objects get moved, this is how the function handles it (with default values present):
<code>
_savepos = [_unwantedObjectsTempPosition, 0, 100, 20, 0, 60 * (pi / 180), 0] call BIS_fnc_findSafePos;
  if((_savepos distance (getArray (configFile >> "CfgWorlds" >> worldName >> "centerPosition"))) = 0) then
  {
    _savepos = _unwantedObjectsTempPosition;
  };
_x setpos _savepos;
</code>
If statement has double equals (comparison statement) but I'm not good enough to actually get wiki formatting right.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 17:29, 2 October 2014


Hover & click on the images for description

Description

Description:
Removes object clutter within a set trigger, for use within cutscenes.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
param spawn BIS_fnc_sceneAreaClearance;
Parameters:
Object - Name of trigger to use as center point.
Array - List of objects that will be kept during cutscene. Optional parameter, default empty array.
Array - Of format Position, where to move all unwanted objects. Optional parameter, default [-5000, 10000, 0].
Return Value:
Nothing

Examples

Example 1:
0 = [triggerArea1] spawn BIS_fnc_sceneAreaClearance;

Additional Information

See also:
See also needed

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

Bottom Section

Posted on October 2, 2014 - 16:29 (UTC)
Tryteyker-
In regards to the 'safe position' where the objects get moved, this is how the function handles it (with default values present): _savepos = [_unwantedObjectsTempPosition, 0, 100, 20, 0, 60 * (pi / 180), 0] call BIS_fnc_findSafePos; if((_savepos distance (getArray (configFile >> "CfgWorlds" >> worldName >> "centerPosition"))) = 0) then { _savepos = _unwantedObjectsTempPosition; }; _x setpos _savepos; If statement has double equals (comparison statement) but I'm not good enough to actually get wiki formatting right.