BIS fnc sceneAreaClearance: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Added params, syntax, example.)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>
| Removes object clutter within a set trigger, for use within cutscenes. |= Description
/*********************************************************************************************************
*
* 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
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_sceneAreaClearance]]; --> |= Syntax
| param spawn [[BIS_fnc_sceneAreaClearance]]; |= Syntax


|p1= |= Parameter 1
|p1= [[Object]] - Name of trigger to use as center point.|= Parameter 1
|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].'' |=


| |= Return value
| [[Nothing]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


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



Revision as of 18:24, 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