BIS_fnc_createSimpleObject

From Bohemia Interactive Community
Jump to navigation Jump to search
Introduced with Arma 3 version 1.62
  

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
1.62

Description

Description:
Creates non-simulated framerate and network performance friendly object - a simple object - and applies different adjustments to fake non-existing physX and engine interactions. The adjustments need either to be stored in the object config or provided as the function input, otherwise they need to be done manually.

Simple objects cannot be destroyed and do not interact with the environment. They are useful for creating low performance-demanding static compositions (walls, rocks, wrecks, …) and/or environments where shooting and collisions are not expected.

Syntax

Syntax:
[input, position, direction, followTerrain, forceSuperSimpleObject] call BIS_fnc_createSimpleObject
Parameters:
input: String or Array:
  • String: classname of the object to be created. This is the preferred way if the asset config definition contains the adjustment data or the data are not needed (most objects do not need adjustments).
  • Array: adjustment data in format [class, model, reversed, verticalOffset, animationAdjustments, selectionsToHide]:
    • class: String - (Optional, default "") asset CfgVehicles config class (at least either model or class must be provided, ideally both)
    • model: String - (Optional, default "") Path to the vehicle p3d model; needs to start without backslash and must end with the proper file extension ".p3d"
    • reversed: Number - (Optional, default 0) some objects, usually vehicles, are reveresed in p3d; valid values are:
      •  0: no change
      •  1: reverse
      • -1: unknown (behaves as 0)
    • verticalOffset: Array - (Optional, default 0) fix for non-existant physX; usually needed only for vehicles
    • animationAdjustments: Array - (Optional, default []) Animation that need to be animated to given state, in format [animationName, animationState]:
      • animationName: String - animation name
      • animationState: Number - animation state
    • selectionsToHide: Array - (Optional, default []) all listed selections will be hidden
 
position: PositionWorld
direction: Number - (Optional, default 0)
followTerrain: Boolean - (Optional, default true) true to follow terrain inclination, false to be horizontally aligned
forceSuperSimpleObject: Boolean - (Optional, default false) true to create a Super Simple Object from p3d path (that must be provided)
Return Value:
Object - the created Simple Object, objNull if creation failed

Examples

Example 1:
["B_Boat_Armed_01_minigun_F", getPosWorld player, getDir player] call BIS_fnc_createSimpleObject;
Example 2:
["B_Boat_Armed_01_minigun_F", player modelToWorldWorld [0,5,0], getDir player + 90, false, false] call BIS_fnc_createSimpleObject;

Additional Information

Execution:
call
Multiplayer:
-
See also:
BIS_fnc_adjustSimpleObjectBIS_fnc_replaceWithSimpleObjectBIS_fnc_simpleObjectData

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Bottom Section