BIS fnc sceneAreaClearance: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|gr1 = Scenes |GROUP1=
|gr1 = Scenes


| Removes object clutter within a set trigger, for use within cutscenes. |DESCRIPTION=
| Removes object clutter within a set trigger, for use within cutscenes.


| param spawn [[BIS_fnc_sceneAreaClearance]]; |SYNTAX=
| param spawn [[BIS_fnc_sceneAreaClearance]];


|p1= [[Object]] - Name of trigger to use as center point.|PARAMETER1=
|p1= [[Object]] - Name of trigger to use as center point.
|p2= ''[[Array]] - List of objects that will be kept during cutscene. Optional parameter, default empty array.'' |Parameter2=
|p2= ''[[Array]] - List of objects that will be kept during cutscene. Optional parameter, default empty array.''


|p3= ''[[Array]] - Of format [[Position]], where to move all unwanted objects. Optional parameter, default [-5000, 10000, 0].'' |PARAMETER3=
|p3= ''[[Array]] - Of format [[Position]], where to move all unwanted objects. Optional parameter, default [-5000, 10000, 0].''


| [[Nothing]] |RETURNVALUE=
| [[Nothing]]


|x1= <code>0 = [triggerArea1] spawn BIS_fnc_sceneAreaClearance;</code> |EXAMPLE1=
|x1= <code>0 = [triggerArea1] spawn BIS_fnc_sceneAreaClearance;</code>


| |SEEALSO=
|


}}
}}

Revision as of 23:48, 17 January 2021

Hover & click on the images for description

Description

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

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

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.