BIS fnc sceneAreaClearance: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(50 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2
____________________________________________________________________________________________
|version1= 1.00


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| <pre>
|game4= arma3
/*********************************************************************************************************
|version4= 0.50
*
* version: 1.0
* name: Scene Area Clearance
* description: removes all unwanted objects from area, except objects passed in parameter
* parameters: _areaCenter: name of TRIGGER (should be set as ACTIVATION BY ANYBODY, PRESENT) - default trigger: BIS_sceneTrigger
* _excludedObjects: ARRAY of object wanted in scene
* _unwantedObjectsTempPosition: POSITION - where to move(hide) all unwanted objects
* return value: nothing
*  
*********************************************************************************************************/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|gr1= Scenes
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_sceneAreaClearance]]; --> |= Syntax
|descr= Removes object clutter within a set trigger, for use within cutscenes.


|p1= |= Parameter 1
|s1= [trigger, objects, destination] spawn [[BIS_fnc_sceneAreaClearance]]


| |= Return value
|p1= trigger: [[Object]] - trigger to use as center point
____________________________________________________________________________________________


|x1= <code></code> |=
|p2= objects: [[Array]] - (Optional, default <sqf inline>[]</sqf>) list of objects that will be kept during cutscene
____________________________________________________________________________________________


| |= See also
|p3= destination: [[Array]] in format [[Position]] - (Optional, default [-5000, 10000, 0]) where to move all unwanted objects


|r1= [[Nothing]]
|x1= <sqf>[triggerArea1] spawn BIS_fnc_sceneAreaClearance;</sqf>
|seealso=
}}
}}


<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
<dt></dt>
<dd class="notedate">Posted on 2014-10-02 - 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):
<sqf>private _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;
</sqf>
</dd>
 
</dl>
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Scenes|{{uc:sceneAreaClearance}}]]
[[Category:Functions|{{uc:sceneAreaClearance}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:sceneAreaClearance}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:sceneAreaClearance}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:sceneAreaClearance}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:sceneAreaClearance}}]]

Latest revision as of 18:09, 8 November 2023

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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:
[trigger, objects, destination] spawn BIS_fnc_sceneAreaClearance
Parameters:
trigger: Object - trigger to use as center point
objects: Array - (Optional, default []) list of objects that will be kept during cutscene
destination: Array in format Position - (Optional, default [-5000, 10000, 0]) where to move all unwanted objects
Return Value:
Nothing

Examples

Example 1:
[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
Posted on 2014-10-02 - 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):
private _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;
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_sceneAreaClearance&oldid=349492"