Difference between revisions of "GetName - Form"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Fg109
m
imported>Terra Nova2
m (→‎Notes: typo)
 
(3 intermediate revisions by 3 users not shown)
Line 8: Line 8:
== Syntax ==
== Syntax ==
<source lang="papyrus">
<source lang="papyrus">
String Function GetName(form BaseObject) native
String Function GetName() native
</source>
</source>


Line 34: Line 34:
== Notes ==
== Notes ==
*This function does not work on actors or object references, use the actor base or base object instead.
*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 ==
== See Also ==
*[[Form Script]]
*[[Form Script]]
*[[SetName - Form]]
*[[SetName - Form]]
*[[GetBaseObject - ObjectReference]]

Latest revision as of 06:36, 27 February 2015

SKSE Member of: Form Script

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

Syntax[edit | edit source]

String Function GetName() native

Parameters[edit | edit source]

  • None.

Return Value[edit | edit source]

  • The name of the form as a string.

Examples[edit | edit source]

; 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[edit | edit source]

  • 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[edit | edit source]