API reference
Preparing search index…

SystemCallbacks

Optional synchronous system virtual implementations.

Missing methods use SFML/upstream behavior. Methods run with this set to this callback object and cannot enter other RmlUi bindings. Time is supplied through SystemInterface.clock without host callbacks.

interface SystemCallbacks {
    activateKeyboard?: (caret: VariantVector2, lineHeight: number) => void;
    deactivateKeyboard?: () => void;
    getClipboardText?: SystemClipboardCallback;
    joinPath?: SystemJoinPathCallback;
    logMessage?: SystemLogCallback;
    setClipboardText?: (text: string) => void;
    setMouseCursor?: (name: string) => void;
    translateString?: SystemTranslateCallback;
}
Source & inheritance
Member directory8

Properties

Properties

activateKeyboard?: (caret: VariantVector2, lineHeight: number) => void

Activate a keyboard at absolute caret coordinates and line height.

Type declaration

    • (caret: VariantVector2, lineHeight: number): void
    • Parameters

      caret

      Absolute caret coordinates.

      lineHeight
      number

      Native line height.

      Returns

      void
Source & inheritance
deactivateKeyboard?: () => void

Deactivate the keyboard.

Source & inheritance
getClipboardText?: SystemClipboardCallback

Read clipboard text synchronously.

Clipboard text.

Source & inheritance

Join a document filename and a resource path.

Source filename.

Referenced resource.

Joined path.

Source & inheritance
logMessage?: SystemLogCallback

Return true to continue, false to request a native debugger break.

Native severity.

Native log text.

Whether to continue native execution.

Source & inheritance
setClipboardText?: (text: string) => void

Replace clipboard text.

Type declaration

    • (text: string): void
    • Parameters

      text
      string

      Clipboard text.

      Returns

      void
Source & inheritance
setMouseCursor?: (name: string) => void

Activate a named mouse cursor.

Type declaration

    • (name: string): void
    • Parameters

      name
      string

      Native cursor name.

      Returns

      void
Source & inheritance
translateString?: SystemTranslateCallback

Translate source text and return its substitution count.

Source text.

Translated text and substitution count.

Source & inheritance

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0