Class CharacterCreatorManager

Namespace

S1API.UI

Assembly

S1API.dll

Provides programmatic control over the in-game character creator UI system. Allows mods to open the character creator, listen for completion events, and retrieve customized avatar settings.

public static class CharacterCreatorManager

Inheritance

object

CharacterCreatorManager

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

ActiveSettings

The current avatar settings being edited in the character creator. Returns null if the creator is not open.

public static BasicAvatarSettings ActiveSettings { get; }

Property Value

BasicAvatarSettings

IsOpen

Whether the character creator is currently open and active.

public static bool IsOpen { get; }

Property Value

bool

Methods

Close()

Closes the character creator without saving changes.

public static void Close()

Complete()

Completes the character customization and closes the creator. Fires the OnCompleted event with the final settings. Camera restoration is handled in the OnCreatorCompleted callback.

public static void Complete()

GetAvailablePresets()

Gets a list of available preset names.

public static string[] GetAvailablePresets()

Returns

string[]

An array of preset names available in the character creator.

Open(BasicAvatarSettings, bool)

Opens the character creator with the specified initial settings.

public static void Open(BasicAvatarSettings initialSettings = null, bool showUI = true)

Parameters

initialSettings BasicAvatarSettings

Optional initial avatar settings. If null, player's current avatar settings are loaded, or default settings if player has none.

showUI bool

Whether to display the UI. Set to false to customize programmatically without showing UI.

PreRegisterAsActiveUI()

Pre-registers the character creator as an active UI element to prevent other systems (like dialogue) from restoring the camera. Call this before ending dialogue or other UI systems to ensure smooth camera transitions.

public static void PreRegisterAsActiveUI()

SelectPreset(string)

Selects a preset by name from the available presets.

public static void SelectPreset(string presetName)

Parameters

presetName string

The name of the preset to select.

SetRigRotation(float)

Rotates the character rig in the character creator.

public static void SetRigRotation(float normalizedValue)

Parameters

normalizedValue float

Rotation value (0.0 to 1.0), where 0.0 is 0 degrees and 1.0 is 359 degrees.

Events

OnClosed

Fired when the character creator is closed without completion.

public static event Action OnClosed

Event Type

Action

OnCompleted

Fired when character customization is completed successfully.

public static event Action<BasicAvatarSettings> OnCompleted

Event Type

Action<BasicAvatarSettings>

Remarks

The BasicAvatarSettings parameter contains the finalized character configuration.

OnOpened

Fired when the character creator is opened.

public static event Action OnOpened

Event Type

Action