SetUIStringAlt

From GECK
Jump to: navigation, search


A function added by the New Vegas Script Extender version 6.0.8.

Description

Sets the value of a string UI trait to a Formatted String.

The trait name is of the format "MenuName/ElementName/ElementName/.../TraitName" as defined in the XML hierarchy for the desired menu, i.e. "MessageMenu/NoGlow_Branch/MM_Title/x".

Returns 1 (true) on successful change, 0 (false) otherwise.

  • Prior to xNVSE 6.2.5, this function did not return anything.

Supersedes SetUIString and SetUIStringEx, which are bugged for templated children tiles.

Syntax

[help]
(success:bool) SetUIStringAlt TraitName:string NewValue:string Formatting 

Notes

  • The path argument has two extra capabilities. A path segment of "*" matches any child tile, and a path segment suffix of ":N" matches the N'th child tile. This is useful when accessing list box items, where the tile names are either identical, or unpredictable, or both.
  • Do not use this command with MCM since it depends on bugged behaviour. Instead use SetUIStringEx.

See Also