BIS fnc simpleObjectData: Difference between revisions

Revision as of 18:24, 21 April 2018

1.62

Hover & click on the images for description

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.

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

Template:note

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:: createSimpleObject BIS_fnc_adjustSimpleObject BIS_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

@@ Line 7: / Line 7: @@
 ____________________________________________________________________________________________
-|Get complete data needed for simple object creation.|= Description
+| Get complete data needed for simple object creation. |= Description
 ____________________________________________________________________________________________
-| [classname] [[call]] '''BIS_fnc_simpleObjectData''' |= Syntax
+| [classname] call [[BIS_fnc_simpleObjectData]] |= Syntax
-|p1=
+|p1= classname: [[Object]] or [[String]]:
-[[String]] - Classname of the object; data are retrieved from the config definition.<br>
+* [[Object]] - Existing object or simple object that will be scanned; if it is a simple object '_reversed' attribute cannot be retrieved<br>
-or<br>
+* [[String]] - Can be either:
-[[Object]] - Existing object or simple object that will be scanned; if it is a simple object '_reversed' attribute cannot be retrieved<br>
+** Classname of the object; data are retrieved from the config definition.
-or<br>
+** 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.
-[[String]] - 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.
+&nbsp;<!-- Return Value jumps up without this atm --> |= Parameter 1
-|= Parameter 1
 ____________________________________________________________________________________________
-|
+| [[Array]] in format [class, model, reversed, verticalOffset, animationAdjustments, hiddenSelections]:
-[[Array]] in format:<br>
+* class: [[String]] - class name from CfgVehicles
-: [[String]] - Class name from CfgVehicles<br>
+* model: [[String]] - path to the vehicle p3d mode
-: [[String]] - Model - Path to the vehicle p3d model<br>
+* reversed: [[Number]] - reverse value, to fix orientation
-: [[Number]] - Reversed - Reverse value, to fix orientation<br>
+* verticalOffset: [[Array]] - vertical offset
-: [[Array]]  - Vertical offset<br>
+* animationAdjustments: [[Array]] - animation adjustments
-: [[Array]] - Animation adjustments<br>
+* hiddenSelections: [[Array]] - hidden selections
-: [[Array]] - Hidden selections<br>
-{{note|Return values can be used in [[BIS_fnc_adjustSimpleObject]]}}|= Return value
+{{note|Return values can be used in [[BIS_fnc_adjustSimpleObject]]}} |= Return value
 ____________________________________________________________________________________________
-|x1= <code>["B_Boat_Armed_01_minigun_F"] [[call]] '''BIS_fnc_simpleObjectData''';</code>|= EXAMPLE1
+|x1= <code>["B_Boat_Armed_01_minigun_F"] [[call]] [[BIS_fnc_simpleObjectData]];</code>|= Example 1
-|x2= <code>[BIS_boat] [[call]] '''BIS_fnc_simpleObjectData''';</code>|= EXAMPLE2
+|x2= <code>[BIS_boat] [[call]] [[BIS_fnc_simpleObjectData]];</code>|= Example 2
 ____________________________________________________________________________________________
-| [[createSimpleObject]], [[BIS_fnc_adjustSimpleObject]], [[BIS_fnc_createSimpleObject]]|= See Also
+| [[createSimpleObject]], [[BIS_fnc_adjustSimpleObject]], [[BIS_fnc_createSimpleObject]] |= See Also
 }}
@@ Line 45: / Line 43: @@
 <dl class="command_description">
 <!-- BEGIN Note Section -->
-<!-- For example:
-<dd class="notedate">Posted on Month Day, Year - Time (UTC)</dd>
-<dt class="note">'''[[User:User Name|User Name]]'''</dt>
-<dd class="note">This is an example note. It is true and verifiable, and contains a little code snippet.
-<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] "Leave it here for others to read"; };</code></dd>
--->
 <!-- END Note Section -->
 </dl>
 <h3 style="display:none">Bottom Section</h3>
-<!-- Appropriate categories go here -->
+[[Category:Arma 3: Functions|{{uc:simpleObjectData}}]]
-[[Category:Arma 3: Functions|{{uc:{{PAGENAME}}}}]]