GetName - Form

From Creation Kit
Jump to: navigation, search

SKSE Member of: Form Script

Returns the name of the passed form. (This function requires SKSE)

Syntax

String Function GetName() native

Parameters

  • None.

Return Value

  • The name of the form as a string.

Examples

; Obtain Bob's name and show a message using it.
String BobName = Bob.GetBaseObject().GetName()
Debug.MessageBox("My name's " + BobName + "!")
; My name's Bob!


; Remove all the NPC's items if his name's Bob
if BobReference.GetBaseObject().GetName() == "Bob"
  BobReference.RemoveAllItems()
endif

Notes

  • This function does not work on actors or object references, use the actor base or base object instead.
  • This doesn't return the name in its EditorID form. But name under the name column. If using this function, take in account for forms that may not have a name.

See Also