Difference between revisions of "NiAVObjectSetLocalTranslation"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>DragoonWraith
imported>DragoonWraith
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:


'''Syntax'''
'''Syntax'''
  (bool:success) NifSetNthChildLocalTranslation TEMP float:x float:y float:z short:ChildID short:NifID
  (bool:success) NiAVObjectSetLocalTranslation array_var:translation short:nifID ''short:blockID''
(bool:success) NiAVObjSetLocTransl array_var:translation short:nifID ''short:blockID''


Sets the local translation of the specified Child of the root node.
Sets the local translation of the <tt>NiAVObject</tt>-derived block specified by <tt>blockID</tt>. The default value of <tt>blockID</tt>, 0, refers to the NIF's root, a <tt>NiNode</tt>, which is a <tt>NiAVObject</tt>-derived class. Thus, this function may be used without an explicit <tt>blockID</tt> when setting the root's local translation.


== Notes ==
The passed <tt>array_var</tt> must be an Array (not a Map or StringMap) and must have exactly 3 numerical elements, corresponding to the x, y, and z axis translations, in that order.
* Because OBSE Plug-Ins cannot currently accept arrays as arguments, this function takes 3 floats instead of one length 3 array of floats. OBSE v1900 is expected to enable the acceptance of arrays, in which case this function will be deprecated in favor of the version that accepts the matrix. Backwards compatibility ''will'' be maintained however.


== See Also ==
== See Also ==
* [[NifGetNthChildLocalTranslation]]
* [[NiAVObjectGetLocalTranslation]]




* [[NifSetNthChildLocalTransformTEMP]]
* [[NiAVObjectSetLocalTransform]]
* [[NifSetNthChildLocalRotationTEMP]]
* [[NiAVObjectSetLocalRotation]]
* [[NifSetNthChildLocalScale]]
* [[NiAVObjectSetLocalScale]]


[[Category:NifSE|SetNthChildTranslation]]
[[Category:NifSE|AVObjectSetTranslation]]
[[Category:NifSE (Children)|SetNthChildTranslation]]
[[Category:NifSE (NiAVObject)|SetTranslation]]

Latest revision as of 12:21, 21 January 2011

This is a command from NifSE.

Syntax

(bool:success) NiAVObjectSetLocalTranslation array_var:translation short:nifID short:blockID
(bool:success) NiAVObjSetLocTransl array_var:translation short:nifID short:blockID

Sets the local translation of the NiAVObject-derived block specified by blockID. The default value of blockID, 0, refers to the NIF's root, a NiNode, which is a NiAVObject-derived class. Thus, this function may be used without an explicit blockID when setting the root's local translation.

The passed array_var must be an Array (not a Map or StringMap) and must have exactly 3 numerical elements, corresponding to the x, y, and z axis translations, in that order.

See Also[edit | edit source]