Script API - v26.70.26
    Preparing search index...

    Interface TransferPlayerUIOptions

    Customizes the progress screen shown while transferring a player to another server. Text fields accept strings or RawMessage values. RawMessage translations are resolved in the receiving player's language.

    interface TransferPlayerUIOptions {
        bodyText?: string | RawMessage;
        bodyVisible?: boolean;
        cancelButtonDelaySeconds?: number;
        cancelButtonText?: string | RawMessage;
        cancelButtonVisible?: boolean;
        titleText?: string | RawMessage;
        titleVisible?: boolean;
    }
    Index
    bodyText?: string | RawMessage

    Custom body text for the transfer progress screen. Accepts a string or a RawMessage. If omitted, the default progress message is used.

    bodyVisible?: boolean

    Boolean to determine if the body text is visible on the server transfer loading screen.

    cancelButtonDelaySeconds?: number

    A delay in seconds before the cancel button is made visible on the server transfer loading screen. This will override the 'cancelButtonVisible' option if set.

    cancelButtonText?: string | RawMessage

    Custom label for the transfer progress screen's cancel button. Accepts a string or a RawMessage. If omitted, the default cancel label is used.

    cancelButtonVisible?: boolean

    Boolean to determine if the cance button text is visible on the server transfer loading screen.

    titleText?: string | RawMessage

    Custom title for the transfer progress screen. Accepts a string or a RawMessage. If omitted, the default progress title is used.

    titleVisible?: boolean

    Boolean to determine if the title text is visible on the server transfer loading screen.