BIS_fnc_simpleObjectData

From Bohemia Interactive Community
Revision as of 04:05, 13 June 2021 by Lou Montana (talk | contribs) (Some wiki formatting)
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Get complete data needed for simple object creation.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
[classname] call BIS_fnc_simpleObjectData
Parameters:
classname: Object or String:
  • Object - Existing object or simple object that will be scanned; if it is a simple object '_reversed' attribute cannot be retrieved
  • String - Can be either:
    • Classname of the object; data are retrieved from the config definition.
    • Path to the p3d; verifies and fixes model path format and returns it in an array (index 1).
      It has very limited functionality in this mode as no data can actually be retrieved from model path.
Return Value:
Array in format [class, model, reversed, verticalOffset, animationAdjustments, selectionsToHide, verticalOffsetWorld, textures, randomizeAnims, randomizeTexs]:
  • class: String - (Default "") class name from CfgVehicles
  • model: String - (Default "") path to the vehicle p3d mode
  • reversed: Number - (Default 0) reverse value, to fix orientation. 0: no change, 1: reverse
  • verticalOffset: Array - (Default 0) vertical offset
  • animationAdjustments: Array - (Default []) animation to animate, every element has this format: [_animationName:string,_animationState:scalar]
  • hiddenSelections: Array - (Default []) all listed selection will be hidden
  • verticalOffsetWorld: Number - vertical offset in World coordinates; similar to ASL but refers to object at [0,0,0], not its land contacts
  • textures: Array - textures currently applied to the object
  • randomizeAnims: Boolean - (Default false) true if vehicle supports randomization through animations
  • randomizeTexs: Boolean - (Default false) true if vehicle supports randomization of textures
Return values can be used with BIS_fnc_adjustSimpleObject.

Examples

Example 1:
["B_Boat_Armed_01_minigun_F"] call BIS_fnc_simpleObjectData;
Example 2:
[BIS_boat] call BIS_fnc_simpleObjectData;

Additional Information

See also:
createSimpleObjectBIS_fnc_adjustSimpleObjectBIS_fnc_createSimpleObject

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