BIS fnc adjustSimpleObject: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix category, description, example and see also)
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(38 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| Arma 3 |= Game
|game1= arma3
|version1= 1.62


|1.62|= Game Version
|gr1= Object Manipulation
____________________________________________________________________________________________


|Adjust simple object vertical position, animations and selection according to provided data.<br>
|descr=Adjust simple object vertical position, animations and selection according to provided data.<br>
'''NOTE:''' function is automatically called by [[BIS_fnc_createSimpleObject]].
In case both adjustment data and class are being used, data has higher priority and only undefined parts are filled from config.
In case both adjustment data and class are being used, data has higher priority and only undefined parts are filled from config. |= Description
____________________________________________________________________________________________


| [object, [class, model, reversed, verticalOffset, animAdjustments, selectionToHide]] [[call]] [[BIS_fnc_adjustSimpleObject]] |= Syntax
{{Feature|important|This function is automatically called by [[BIS_fnc_createSimpleObject]].}}


|p1= [[Object]]: Simple object that will be adjusted |= Parameter 1
|s1= [object, [class, model, reversed, verticalOffset, animAdjustments, selectionToHide]] call [[BIS_fnc_adjustSimpleObject]]


|p2= [[Array]]: Adjustment data in format [class, model, reversed, verticalOffset, animationAdjustments, selectionsToHide]:
|p1= object: [[Object]] - simple object that will be adjusted
* class: [[String]] - (default "") asset CfgVehicles config class ('''at least either ''model'' or ''class'' must be provided, ideally both''')
* model: [[String]] - (default "") Path to the vehicle p3d model; needs to start without backslash and must end with the proper file extension ".p3d"
* reversed: [[Number]] - (default 0) some objects, usually vehicles, are reveresed in p3d; valid values are:
** &nbsp;0: no change
** &nbsp;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 |= Parameter 2
____________________________________________________________________________________________


| [[Nothing]] |= Return value
|p2= class: [[String]] - (Optional, default "") asset {{hl|CfgVehicles}} config class ('''at least either ''model'' or ''class'' must be provided, ideally both''')
____________________________________________________________________________________________


|x1= <code>[myCar, ["B_MyCar_F", "path\to\file.p3d"]] [[call]] [[BIS_fnc_adjustSimpleObject]];</code>|= Example 1
|p3= model: [[String]] - (Optional, default "") path to the vehicle p3d model; needs to start without backslash and must end with the proper file extension ".p3d"


____________________________________________________________________________________________
|p4= reversed: [[Number]] - (Optional, default 0) some objects, usually vehicles, are reveresed in p3d; valid values are:
* &nbsp;0: no change
* &nbsp;1: reverse
* -1: unknown (behaves as 0)


| [[createSimpleObject]], [[BIS_fnc_createSimpleObject]], [[BIS_fnc_simpleObjectData]] |= See Also
|p5= verticalOffset: [[Array]] - (Optional, default 0) fix for non-existant physX; usually needed only for vehicles


}}
|p6= animationAdjustments: [[Array]] - (Optional, default <sqf inline>[]</sqf>) animation that need to be animated to given state, in format [animationName, animationState]:
* animationName: [[String]] - animation name
* animationState: [[Number]] - animation state
 
|p7= selectionsToHide: [[Array]] - (Optional, default <sqf inline>[]</sqf>) all listed selections will be hidden
 
|r1= [[Nothing]]


<dl class="command_description">
|x1= <sqf>[myCar, ["B_MyCar_F", "path\to\file.p3d"]] call BIS_fnc_adjustSimpleObject;</sqf>
<!-- 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>
|seealso= [[createSimpleObject]] [[BIS_fnc_createSimpleObject]] [[BIS_fnc_simpleObjectData]]
<!-- Appropriate categories go here -->
}}
[[Category:Arma 3: Functions|{{uc:adjustSimpleObject}}]]

Latest revision as of 18:09, 8 November 2023

Arma 3 logo black.png1.62
Hover & click on the images for description

Description

Description:
Adjust simple object vertical position, animations and selection according to provided data.
In case both adjustment data and class are being used, data has higher priority and only undefined parts are filled from config.
⚠
This function is automatically called by BIS_fnc_createSimpleObject.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
[object, [class, model, reversed, verticalOffset, animAdjustments, selectionToHide]] call BIS_fnc_adjustSimpleObject
Parameters:
object: Object - simple object that will be adjusted
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
Return Value:
Nothing

Examples

Example 1:
[myCar, ["B_MyCar_F", "path\to\file.p3d"]] call BIS_fnc_adjustSimpleObject;

Additional Information

See also:
createSimpleObject 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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_adjustSimpleObject&oldid=349493"