Difference between revisions of "NiAVObjectSetLocalTranslation"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>DragoonWraith
m (→‎See Also: removing TEMP)
imported>DragoonWraith
 
Line 2: Line 2:


'''Syntax'''
'''Syntax'''
  (bool:success) NiAVObjectSetLocalTranslationTEMP float:x float:y float:z short:nifID ''short:blockID''
  (bool:success) NiAVObjectSetLocalTranslation array_var:translation short:nifID ''short:blockID''
  (bool:success) NiAVObjSetLocTranslT float:x float:y float:z short:nifID ''short:blockID''
  (bool:success) NiAVObjSetLocTransl array_var:translation short:nifID ''short:blockID''


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.
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, <tt>NiAVObjectSetLocalTranslation</tt>, as it would properly exist, cannot be implemented. <tt>NiAVObjectSetLocalTranslationTEMP</tt> is provided as an alternative; it will be deprecated in favor of <tt>NiAVObjectSetLocalTranslation</tt> when OBSE adds the ability to take array arguments, but backwards compatibility will be maintained.


== See Also ==
== See Also ==

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]