RSX Code Reference
    Preparing search index...

    Class AgentSettings

    Persisted configuration and sessions for the editor agent.

    Hierarchy (View Summary)

    Index
    constructor
    activeProviderId customSystemPrompt isAgentSelectionVisibleInViewport isCompactTimelineEnabled toolApprovalMode
    activeProviderProfile isGlobal
    assign markAsDirty markDirtyForAutoSave
    onDirty
    activeProviderId: UUID

    Active provider profile id used by agent turns and LLM service configuration.

    customSystemPrompt: string
    isAgentSelectionVisibleInViewport: boolean

    Whether the Agent selection highlight is visible in scene viewports.

    isCompactTimelineEnabled: boolean

    Whether intermediate Agent work is grouped into compact timeline markers.

    toolApprovalMode: AgentToolApprovalMode

    Project-level approval behavior for permissioned Agent tools.

    • get isGlobal(): boolean

      Gets the settings.

      Returns boolean

    • Copies all properties defined by the prototype of other to this instance.

      Parameters

      • other: Readonly<T>

      Returns void

    • Marks the settings as dirty and invokes the onDirty event handler.

      Returns void

      This method should be invoked after making a change, so subsystems such as a viewport cna be updated. If the settings are the shared editor settings, the editor settings will be marked for autosave.

    • Marks agent settings dirty without requiring inspector interaction.

      Parameters

      • justification: string

      Returns void

    onDirty: Event<[AgentSettings], void>

    Invoked when the settings changed.

    This is an internal event. Do not subscribe directly to it, use UserProjectSettings.onSettingsChanged.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods
    Events