Difference between revisions of "GetName - Form"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Fg109
m
imported>Fg109
Line 8: Line 8:
== Syntax ==
== Syntax ==
<source lang="papyrus">
<source lang="papyrus">
String Function GetName(form BaseObject) native
String Function GetName() native
</source>
</source>



Revision as of 12:14, 14 May 2012

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.

See Also