BIS fnc replaceWithSimpleObject: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
(27 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.62


| arma3 |= Game name
|gr1= Object Manipulation


|1.00|= Game version
|descr= Replaces a normal object with a [[Arma 3 Simple Objects|Simple Object]].
____________________________________________________________________________________________
Object must not contain any crew and must be placed on the ground.
{{Feature|informative|
* Useful if you do not have access to simple object adjustment data - e.g. in case of unsupported/discontinued asset.
* All official assets have the adjustment data defined in config.}}


| <pre>/*
|pr= Use with caution as this technique is not very clean - it should not be used for many objects and definitely '''not''' in MP games.
Author: Jiri Wainar


Description:
|s1= [object] call [[BIS_fnc_replaceWithSimpleObject]]
Replaces object with simple object. Object must not contain any crew and must be placed on ground.


Remarks:
|p1= object: [[Object]] - the object that will be replaced by a simple object
* Useful if you do not have access to simple object adjustment data - e.g. in case of unsupported/discontinued asset.
* All official assets have the adjustment data defined in config.
* Use with caution as this technique is not very clean - should not be used for many objects and definatelly not in MP games.


Parameter(s):
|r1= [[Object]] - the created [[Arma 3 Simple Objects|Simple Object]]
0: OBJECT - object that will be replaced by simple object
1: BOOL - force super-simple object (default: false); true: super-simple object will be force, no type info or re-texturing is available, false: super-simple object is used unless re-texturing is possible


Returns:
|x1= <sqf>[tank] call BIS_fnc_replaceWithSimpleObject;</sqf>
OBJECT - simple object that replaced the simulated object
 
Example:
[_object:object] call BIS_fnc_replaceWithSimpleObject;
 
See also:
* bis_fnc_createSimpleObject
* bis_fnc_replaceWithSimpleObject
* bis_fnc_simpleObjectData
* bis_fnc_exportCfgVehiclesSimpleObjectData
* bis_fnc_diagMacrosSimpleObjectData
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_replaceWithSimpleObject]]; --> |= Syntax
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[createSimpleObject]] [[BIS_fnc_adjustSimpleObject]] [[BIS_fnc_createSimpleObject]] [[BIS_fnc_simpleObjectData]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: SimpleObjects|{{uc:replaceWithSimpleObject}}]]
[[Category:Functions|{{uc:replaceWithSimpleObject}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:replaceWithSimpleObject}}]]

Revision as of 01:24, 2 February 2024

Hover & click on the images for description

Description

Description:
Replaces a normal object with a Simple Object. Object must not contain any crew and must be placed on the ground.
  • Useful if you do not have access to simple object adjustment data - e.g. in case of unsupported/discontinued asset.
  • All official assets have the adjustment data defined in config.
Execution:
call
Problems:
Use with caution as this technique is not very clean - it should not be used for many objects and definitely not in MP games.
Groups:
Object Manipulation

Syntax

Syntax:
[object] call BIS_fnc_replaceWithSimpleObject
Parameters:
object: Object - the object that will be replaced by a simple object
Return Value:
Object - the created Simple Object

Examples

Example 1:
[tank] call BIS_fnc_replaceWithSimpleObject;

Additional Information

See also:
createSimpleObject BIS_fnc_adjustSimpleObject BIS_fnc_createSimpleObject BIS_fnc_simpleObjectData

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