Difference between revisions of "NiObjectNETGetExtraDataByName"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>DragoonWraith
m (NifGetExtraDataIndexByName moved to NiObjectNETGetExtraDataByName: new name for function as of alpha 5.)
imported>DragoonWraith
Line 2: Line 2:


'''Syntax'''
'''Syntax'''
(short:ExtraDataIndex) NifGetExtraDataIndexByName string:Name short:NifID
(short:extraDataID) NiObjectNETGetExtraDataByName string:name short:nifID ''short:blockID''
(short:extraDataID) NiObjNETGetEDByName string:name short:nifID ''short:blockID''


Searches the extra data list of the specified <tt>NiObjectNET</tt>-derived block for an extra data with the given name. Returns -1 if no such extra data exists. As usual, <tt>blockID</tt> defaults to 0, indicating the root <tt>NiNode</tt> - which is a <tt>NiObjectNET</tt>-derived class, so this function works with the default argument.
Returns the index by which the specified ExtraData node of the specified nif can be referred for other functions. Returns -1 if the specified node is not found.


⚫
[[Category:NifSE|ExtraDataGetExtraDataByName]]
== See Also ==
[[Category:NifSE (NiExtraData)|GetExtraDataByName]]
* [[NifGetNthExtraDataName]]
* [[NifSetNthExtraDataName]]

⚫
[[Category:NifSE|GetExtraDataIndexByName]]
[[Category:NifSE (ExtraData)|GetExtraDataIndexByName]]

Revision as of 21:00, 28 August 2010

This is a command from NifSE.

Syntax

(short:extraDataID) NiObjectNETGetExtraDataByName string:name short:nifID short:blockID
(short:extraDataID) NiObjNETGetEDByName string:name short:nifID short:blockID

Searches the extra data list of the specified NiObjectNET-derived block for an extra data with the given name. Returns -1 if no such extra data exists. As usual, blockID defaults to 0, indicating the root NiNode - which is a NiObjectNET-derived class, so this function works with the default argument.