BIS fnc simpleObjectData: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Fix category and description) |
m (template:command argument fix) |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Get complete data needed for simple object creation. |= | | Get complete data needed for simple object creation. |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [classname] call [[BIS_fnc_simpleObjectData]] |= | | [classname] call [[BIS_fnc_simpleObjectData]] |SYNTAX= | ||
|p1= classname: [[Object]] or [[String]]: | |p1= classname: [[Object]] or [[String]]: | ||
| Line 17: | Line 17: | ||
** Classname of the object; data are retrieved from the config definition. | ** 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).<br />It has very limited functionality in this mode as no data can actually be retrieved from model path. | ** Path to the p3d; verifies and fixes model path format and returns it in an array (index 1).<br />It has very limited functionality in this mode as no data can actually be retrieved from model path. | ||
<!-- Return Value jumps up without this atm --> |= | <!-- Return Value jumps up without this atm --> |PARAMETER1= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 28: | Line 28: | ||
* hiddenSelections: [[Array]] - hidden selections | * hiddenSelections: [[Array]] - hidden selections | ||
{{note|Return values can be used in [[BIS_fnc_adjustSimpleObject]]}} |= | {{note|Return values can be used in [[BIS_fnc_adjustSimpleObject]]}} |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>["B_Boat_Armed_01_minigun_F"] [[call]] [[BIS_fnc_simpleObjectData]];</code>|= | |x1= <code>["B_Boat_Armed_01_minigun_F"] [[call]] [[BIS_fnc_simpleObjectData]];</code>|EXAMPLE1= | ||
|x2= <code>[BIS_boat] [[call]] [[BIS_fnc_simpleObjectData]];</code>|= | |x2= <code>[BIS_boat] [[call]] [[BIS_fnc_simpleObjectData]];</code>|EXAMPLE2= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[createSimpleObject]], [[BIS_fnc_adjustSimpleObject]], [[BIS_fnc_createSimpleObject]] |= | | [[createSimpleObject]], [[BIS_fnc_adjustSimpleObject]], [[BIS_fnc_createSimpleObject]] |SEEALSO= | ||
}} | }} | ||
Revision as of 14:33, 7 April 2019
Description
- Description:
- Get complete data needed for simple object creation.
- Execution:
- call
- Groups:
- Uncategorised
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.
- Object - Existing object or simple object that will be scanned; if it is a simple object '_reversed' attribute cannot be retrieved
- Return Value:
- Array in format [class, model, reversed, verticalOffset, animationAdjustments, hiddenSelections]:
- class: String - class name from CfgVehicles
- model: String - path to the vehicle p3d mode
- reversed: Number - reverse value, to fix orientation
- verticalOffset: Array - vertical offset
- animationAdjustments: Array - animation adjustments
- hiddenSelections: Array - hidden selections
Examples
- Example 1:
["B_Boat_Armed_01_minigun_F"] call BIS_fnc_simpleObjectData;- Example 2:
[BIS_boat] call BIS_fnc_simpleObjectData;
Additional Information
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