Background for Skyrim SE
Member of the ObjectReference script
boolfunctionSetDisplayName(stringname, boolforce=false)Native

[DEV SERVER] Loading description...


Caveats

CK Wiki - Notes

  • This function uses the same system that quest aliases use to rename forms ("ExtraTextDisplayData" internally). This is why this function can conflict with quest alias name changes.
    • It is not known whether a newly-applied quest alias would overwrite changes made by this function. Further research is required.

Parameters

stringname

CK Wiki Description

** The name to set.

boolforce=false

CK Wiki Description

** If this argument is True, and the reference already has its name changed by a quest alias, then this function will overwrite that name change. If this argument is False, then this function will only make changes if the reference's current display name doesn't come from a quest alias.


Examples

; rename the amulet
If myAmuletOfTalos.SetDisplayName("Amulet of the Ninth Divine", False) == False
   Debug.Trace("Failed to rename the amulet. A quest alias may already be renaming it.")
EndIf

Auto-Generated Example

string myString__name
bool myBool__force

bool returnedValue = myObjectReference__toCallFunctionOn.SetDisplayName(myString__name, myBool__force)

Related Pages


Additional References

View this function’s page on the Skyrim Creation Kit Wiki

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.