SetRefName

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Sets the name of the calling reference. Unlike SetName/SetNameEx/LNSetName, all of which change the name of every instance of the Base Form, this function assigns a name unique only to the reference.

  • If the newName argument is omitted, the reference's name is reset to the default one.
  • To retrieve the unique name of a reference (if any), LNGetName should be used; GetName etc will only return the base form's name.

Syntax

[help]
reference.SetRefName newName:string

Example

objectRef.SetRefName "Gussie the Newt Fancier" 

Notes

  • This function is only session-persistent.