GetName - Form

From the Fallout4 CreationKit Wiki
Revision as of 14:35, 21 January 2018 by imported>Qazaaq (removed incomplete)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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