Difference between revisions of "NiExtraDataSetString"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>DragoonWraith
imported>DragoonWraith
 
Line 2: Line 2:


'''Syntax'''
'''Syntax'''
(bool:success) NifSetNthExtraDataString string:NewValue short:ExtraDataID short:NifID
(bool:success) NiExtraDataSetString string:newValue short:nifID ''short:blockID''
(bool:success) NiEDSetStr string:newValue short:nifID ''short:blockID''


If <tt>blockID</tt> refers to a <tt>NiStringExtraData</tt>-derived block, sets the value of the block's string variable to <tt>newValue</tt>. Since <tt>NiNode</tt> does not derive from <tt>NiStringExtraData</tt> and <tt>blockID</tt> defaults to 0, or the NIF's root, this function will almost always require an explicit <tt>blockID</tt>.
Sets the value of a StringExtraData node to the specified value. If the specified ExtraData node is not a StringExtraData node, or if the process fails for any other reason, returns 0 and an error is reported to the console and NifSE.log.


== See Also ==
== See Also ==
* [[NiExtraDataGetString]]
* [[NifGetNthExtraDataString]]


[[Category:NifSE|SetNthExtraDataString]]
[[Category:NifSE|ExtraDataSetString]]
[[Category:NifSE (ExtraData)|SetNthExtraDataString]]
[[Category:NifSE (NiExtraData)|SetString]]

Latest revision as of 14:26, 29 August 2010

This is a command from NifSE.

Syntax

(bool:success) NiExtraDataSetString string:newValue short:nifID short:blockID
(bool:success) NiEDSetStr string:newValue short:nifID short:blockID

If blockID refers to a NiStringExtraData-derived block, sets the value of the block's string variable to newValue. Since NiNode does not derive from NiStringExtraData and blockID defaults to 0, or the NIF's root, this function will almost always require an explicit blockID.

See Also[edit | edit source]