Glamourer.Api

The full API available.

Basic API functions.

Get the current API version of the Glamourer available in this installation. Major version changes indicate incompatibilities, minor version changes are backward-compatible additions.

All functions related to Glamourer designs.

Obtain a list of all available designs.

A dictionary of all designs from their GUID to their current display name.

Apply an existing design to an actor.

The GUID of the design to apply. The game object index of the actor to be manipulated. A key to unlock or lock the state if necessary. The flags used for the reversion. Respects Once, Equipment, Customization, Lock (see .) DesignNotFound, ActorNotFound, InvalidKey, Success.

Apply an existing design to an actor.

The GUID of the design to apply. The name of the players to be manipulated. A key to unlock or lock the state if necessary. The flags used for the reversion. Respects Once, Equipment, Customization, Lock (see .) DesignNotFound, ActorNotFound, InvalidKey, Success. /// The player does not have to be currently available as long as he has a persisted Glamourer state.
Only players are checked for name equality, no NPCs.
If multiple players of the same name are found, all of them are reverted.
Prefer to use the index-based function unless you need to get the state of someone currently unavailable.

All functions related to items.

Set a single item on an actor.

The game object index of the actor to be manipulated. The slot to apply the item to. The (Custom) ID of the item to apply. The IDs of the stains to apply to the item. A key to unlock or lock the state if necessary. The flags used for the reversion. Respects Once (see .) ItemInvalid, ActorNotFound, ActorNotHuman, InvalidKey, Success. The item ID can be a custom item ID in Glamourer's format for models without an associated item, or a normal game item ID.

Set a single item on players.

The name of the players to be manipulated. The slot to apply the item to. The (Custom) ID of the item to apply. The IDs of the stains to apply to the item. A key to unlock or lock the state if necessary. The flags used for the reversion. Respects Once (see .) ItemInvalid, ActorNotFound, ActorNotHuman, InvalidKey, Success. The item ID can be a custom item ID in Glamourer's format for models without an associated item, or a normal game item ID.
The player does not have to be currently available as long as he has a persisted Glamourer state.
Only players are checked for name equality, no NPCs.
If multiple players of the same name are found, all of them are modified.
Prefer to use the index-based function unless you need to get the state of someone currently unavailable.

Set a single bonus item on an actor.

The game object index of the actor to be manipulated. The bonus slot to apply the item to. The bonus item sheet ID of the item to apply (including stain). A key to unlock or lock the state if necessary. The flags used for the reversion. Respects Once (see .) ItemInvalid, ActorNotFound, ActorNotHuman, InvalidKey, Success. The bonus item ID can currently not be a custom item ID in Glamourer's format for models without an associated item. Use 0 to remove the bonus item.
The player does not have to be currently available as long as he has a persisted Glamourer state.
Only players are checked for name equality, no NPCs.
If multiple players of the same name are found, all of them are modified.
Prefer to use the index-based function unless you need to get the state of someone currently unavailable.

Set the defined Meta State flags to the active or inactive state on actor.

The game object index of the actor to be manipulated. The flags defining which meta states to update to the new value. This can be multiple at once. The new value to update to. A key to unlock or lock the state if necessary. The flags used for the reversion. Respects Once (see .) ItemInvalid, ActorNotFound, ActorNotHuman, InvalidKey, Success.

Set the defined Meta State flags to the active or inactive state on actor (by name)

The name of the players to be manipulated. The flags defining which meta states to update to the new value. This can be multiple at once. The new value to update to. A key to unlock or lock the state if necessary. The flags used for the reversion. Respects Once (see .) ItemInvalid, ActorNotFound, ActorNotHuman, InvalidKey, Success.

Any functions related to Glamourer's state tracking.

Get the current Glamourer state of an actor.

The game object index of the desired actor. A key to unlock the state if necessary. ActorNotFound, InvalidKey or Success, and the state on success. The actor does not need to have a prior Glamourer state as long as it can be found.

Get the current Glamourer state of a player character.

The name of the desired player. A key to unlock the state if necessary. ActorNotFound, InvalidKey or Success, and the state on success. The player does not have to be currently available as long as he has a persisted Glamourer state. Only players are checked for name equality, no NPCs. If multiple players of the same name are found, the first is returned. Prefer to use the index-based function unless you need to get the state of someone currently unavailable.

Apply a supplied state to an actor.

The state, which can be either a Glamourer-supplied JObject or a Base64 string. The game object index of the actor to be manipulated. A key to unlock or lock the state if necessary. The flags used for the application. Respects Once, Equipment, Customization and Lock (see .) ActorNotFound, InvalidKey, ActorNotHuman, Success.

Apply a supplied state to players.

The state, which can be either a Glamourer-supplied JObject or a Base64 string. The name of the player to be manipulated. A key to unlock or lock the state if necessary. The flags used for the application. Respects Once, Equipment, Customization and Lock (see .) ActorNotFound, InvalidKey, ActorNotHuman, Success. The player does not have to be currently available as long as he has a persisted Glamourer state.
Only players are checked for name equality, no NPCs.
If multiple players of the same name are found, all of them are manipulated.
Prefer to use the index-based function unless you need to get the state of someone currently unavailable.

Revert the Glamourer state of an actor to Game state.

The game object index of the actor to be manipulated. A key to unlock the state if necessary. The flags used for the reversion. Respects Equipment and Customization (see .) ActorNotFound, InvalidKey, Success, NothingDone.

Revert the Glamourer state of players to game state.

The name of the players to be reverted. A key to unlock the state if necessary. The flags used for the reversion. Respects Equipment and Customization (see .) ActorNotFound, InvalidKey, Success, NothingDone. /// The player does not have to be currently available as long as he has a persisted Glamourer state.
Only players are checked for name equality, no NPCs.
If multiple players of the same name are found, all of them are reverted.
Prefer to use the index-based function unless you need to get the state of someone currently unavailable.

Unlock the Glamourer state of an actor with a key.

The game object index of the actor to be manipulated. A key to unlock the state. ActorNotFound, InvalidKey, Success, NothingDone.

Unlock the Glamourer state of players with a key.

The name of the players to be unlocked. A key to unlock the state. InvalidKey, Success, NothingDone.

Unlock all active glamourer states with a key.

The key to unlock states with. The number of unlocked states.

Revert the Glamourer state of an actor to automation state.

The game object index of the actor to be manipulated. A key to unlock the state if necessary. The flags used for the reversion. Respects Once and Lock (see .) ActorNotFound, InvalidKey, Success, NothingDone.

Revert the Glamourer state of players to automation state.

The name of the players to be reverted. A key to unlock the state if necessary. The flags used for the reversion. Respects Once and Lock (see .) ActorNotFound, InvalidKey, Success, NothingDone. /// The player does not have to be currently available as long as he has a persisted Glamourer state.
Only players are checked for name equality, no NPCs.
If multiple players of the same name are found, all of them are reverted.
Prefer to use the index-based function unless you need to get the state of someone currently unavailable.

Invoked with the game object pointer (if available) whenever an actors tracked state changes.

Invoked with the game object pointer (if available) whenever an actors tracked state changes, with the type of change.

Invoked with the game object pointer (if available) whenever an actors tracked state finalizes a grouped change consisting of multiple smaller changes.

Invoked when the player enters or leaves GPose (true => entered GPose, false => left GPose).

Bonus item slots restricted to API-relevant slots.

No slot.

The Glasses slot.

Equip slots restricted to API-relevant slots, but compatible with GameData.EquipSlots.

No slot.

Mainhand, also used for both-handed weapons.

Offhand, used for shields or if you want to apply the offhand component of certain weapons.

Head.

Body.

Hands.

Legs.

Feet.

Ears.

Neck.

Wrists.

Right Finger.

Left Finger.

Not officially existing, means "weapon could be equipped in either hand" for the game.

Application flags that can be used in different situations.

Apply the selected manipulation only once, without forcing the state into automation.

Apply the selected manipulation on the equipment (might be more or less supported).

Apply the selected manipulation on the customizations (might be more or less supported).

Lock the state with the given key after applying the selected manipulation

Extensions for apply flags.

The default application flags for design-based manipulations.

The default application flags for state-based manipulations.

The default application flags for reverse manipulations.

Return codes for API functions.

The function succeeded.

The function did not encounter a problem, but also did not do anything.

The requested actor was not found.

The requested actor was not human, but should have been.

The requested design was not found.

The requested item was not found or could not be applied to the requested slot.

The state of an actor could not be manipulated because it was locked and the provided key could not unlock it.

The provided object could not be converted into a valid Glamourer state to apply.

Application flags for setting the meta state of an actor.

What type of information changed in a state.

A characters saved state had the model id changed. This means everything may have changed.

A characters saved state had multiple customization values changed.

A characters saved state had a customization value changed.

A characters saved state had an equipment piece changed.

A characters saved state had its weapons changed.

A characters saved state had a stain changed.

A characters saved state had a crest visibility changed.

A characters saved state had its customize parameter changed.

A characters saved state had a material color table value changed.

A characters saved state had a design applied. This means everything may have changed.

A characters saved state had its state reset to its game values.

A characters saved state had a meta toggle changed.

A characters state was reapplied. Data is null.

A characters saved state had a bonus item changed.

What type of Glamourer process was performed on the actors state to update it.

A characters saved state had the model id altered.

A singular Design was applied to an actors state.

A characters saved state had been reset to game values.

A characters saved state had only its customization data reset to game state.

A characters saved state had only its equipment data reset to game state.

A characters saved state had its advanced values reverted to game state.

A characters saved state was reverted to automation state on top of their game state

A characters saved state had a generic reapply as a single operation.

A characters saved state had their automation state reapplied over their existing state.

A characters save state finished applying all updated slots for game state on gearset change or initial load.

Specialized subscriber only allowing to invoke actions.

Whether the subscriber could successfully be created.

Invoke the action. See the source of the subscriber for details.

Whether the subscriber could successfully be created.

Invoke the action. See the source of the subscriber for details.

Specialized disposable Provider for Events. Will execute the unsubscriber action on dispose if any is provided. Can only be invoked and disposed.

Invoke the event.

Specialized disposable Subscriber for Events. Subscriptions are wrapped to be individually exception-safe. Can be enabled and disabled.

Enable all currently subscribed actions registered with this EventSubscriber. Does nothing if it is already enabled.

Disable all subscribed actions registered with this EventSubscriber. Does nothing if it is already disabled. Does not forget the actions, only disables them.

Add or remove an action to the IPC event, if it is valid.

Specialized disposable Provider for Funcs.

Specialized subscriber only allowing to invoke functions with a return.

Whether the subscriber could successfully be created.

Invoke the function. See the source of the subscriber for details.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

Triggered when the Glamourer API is initialized and ready.

The label.

Create a new event subscriber.

Create a provider.

Triggered when the Glamourer API is fully disposed and unavailable.

The label.

Create a new event subscriber.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a provider.

The label.

Create a new event subscriber.

Create a provider.

The label.

Create a new event subscriber.

Create a provider.

The label.

Create a new event subscriber.

Create a provider.

The label.

Create a new event subscriber.

Create a provider.