Back to index...

NameTypeDeprecatedSecureDescription
Command.Title.PrefixfunctionChanges the player's prefix title.
Command.Title.SuffixfunctionChanges the player's suffix title.
Event.Title.AddSignals the addition of a new title.
Inspect.Title.Category.DetailfunctionProvides detailed information about a title category.
Inspect.Title.Category.ListfunctionLists known title categories.
Inspect.Title.DetailfunctionProvides detailed information about a title.
Inspect.Title.ListfunctionLists the player's currently available titles.

Command.Title.Prefix

Changes the player's prefix title.

Usage:

Throttled.

Command.Title.Prefix(title)
ParameterTypeDatatypeDescription
titleparametertitle, nilThe ID of the new title to set, or "nil" for no title.

Command.Title.Suffix

Changes the player's suffix title.

Usage:

Throttled.

Command.Title.Suffix(title)
ParameterTypeDatatypeDescription
titleparametertitle, nilThe ID of the new title to set, or "nil" for no title.

Event.Title.Add

Signals the addition of a new title.

Usage:

Event.Title.Add(titles)
ParameterTypeDatatypeDescription
titlesparametervariantA lookup table of newly available titles.

Inspect.Title.Category.Detail

Provides detailed information about a title category.

Usage:

detail = Inspect.Title.Category.Detail(titlecategory)
details = Inspect.Title.Category.Detail(titlecategories)
ParameterTypeDatatypeDescription
titlecategoriesparametertableA table of title categories to retrieve details for.
titlecategoryparametertitlecategoryThe title category to retrieve detail for.
detailresulttableDetail table for a single title category.
detailsresulttableDetail tables for all requested title categories.
members
id The ID of the required element.
name The name of the title category.

Inspect.Title.Category.List

Lists known title categories.

Usage:

titlecategories = Inspect.Title.Category.List()
ParameterTypeDatatypeDescription
titlecategoriesresulttableA lookup table of known title categories.

Inspect.Title.Detail

Provides detailed information about a title.

Usage:

detail = Inspect.Title.Detail(title)
details = Inspect.Title.Detail(titles)
ParameterTypeDatatypeDescription
titleparametertitleThe title ID to retrieve detail for.
titlesparametertableA table of title IDs to retrieve detail for.
detailresulttableDetail table for a single title.
detailsresulttableDetail tables for all requested titles.
members
gameFemale The title as seen ingame and applied to female characters.
gameMale The title as seen ingame and applied to male characters.
id The ID of the requested element.
nameFemale The title as seen in menus and applied to female characters.
nameMale The title as seen in menus and applied to male characters.
prefix Signals that the title is a prefix title.

Inspect.Title.List

Lists the player's currently available titles.

Usage:

titles = Inspect.Title.List()
ParameterTypeDatatypeDescription
titlesresulttableA lookup table of all available titles.

Back to index...