Difference between revisions of "GetName - Form"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
(style and example tweak for actor name)
imported>Qazaaq
(added required f4se version)
Line 1: Line 1:
[[Category:Scripting]]
{{Template:Incomplete Article}}
[[Category:Papyrus]]
[[Category:F4SE]]
 
'''F4SE member of:''' [[Form Script]]
'''F4SE member of:''' [[Form Script]]
{{Template:Papyrus:RequiredF4SE|version=0.3.1}}


Gets the name of the form, full name if possible. Requires F4SE 0.03.1.
Gets the name of the form, full name if possible.


== Syntax ==
== Syntax ==
Line 34: Line 32:
== See Also ==
== See Also ==
[[Form Script]]
[[Form Script]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:F4SE]]

Revision as of 14:30, 21 January 2018

This article has been flagged as incomplete.
Please help improve the wiki by learning how to contribute.

F4SE member of: Form Script
Requires F4SE version 0.3.1 or higher.

Gets the name of the form, full name if possible.

Syntax

string Function GetName() Native

Parameters

None

Return Value

The name of the form as a string.

Examples

; If you want to know the name of player's current cell.
string cellName = Game.GetPlayer().GetParentCell().GetName()
Debug.Trace("My parent cell's name is: " + cellName)

; If you want to know an actor's name.
string prestonName = PrestonRef.GetActorBase().GetName()
Debug.Trace(prestonName + " says hello.")

Notes

  • For actors and object references, must be used on the base object.
  • The return value is the name found under the name column for objects in the editor.

See Also

Form Script