API リファレンス
検索インデックスを準備中…

RmlUi イベントのコピー。ネイティブ伝播制御は現在のコールバック中のみ有効。

各リスナーは投影座標を含む独自のコピーを受け取ります。保存した項目は読めますが、 コールバック終了後の伝播状態取得と停止操作は例外になります。id はイベントの種類です。

継承関係

階層 (概要を見る)

ソースと継承
メンバー一覧25

コンストラクター

プロパティ

アクセッサー

メソッド

コンストラクター

  • 上流の既定状態で所有 Rml::Event を構築します。

    戻り値

    初期化済みランタイムが必要です。対象と現在要素は null、型とパラメーターは 空、ID は Invalid、段階は None。中断不可。解放・GC・終了で所有権を終了します。

    ソースと継承

プロパティ

id: number

ネイティブ EventId。

ソースと継承
isInterruptible: boolean

中断可能か。

ソースと継承
parameters: Readonly<Record<string, VariantValue>>

Rml::Event::GetParameters からコピーした型付きパラメーター。

ソースと継承
target: null | Element

対象要素。既定構築のイベントでは null。

ソースと継承
targetId: string

対象 id のコピー。

ソースと継承
type: string

イベント型。

ソースと継承
unprojectedMouseScreenPosition: VariantVector2

Rml::Event::GetUnprojectedMouseScreenPos の物理ピクセル座標コピー。

ソースと継承

アクセッサー

  • get isImmediatePropagating(): boolean

    Rml::Event::IsImmediatePropagating。ネイティブイベントが有効な間使えます。

    戻り値

    boolean

    この要素の残りのリスナーを実行できるかどうか。

    ソースと継承
  • get isPropagating(): boolean

    Rml::Event::IsPropagating。ネイティブイベントが有効な間使えます。

    戻り値

    boolean

    伝播を継続できるかどうか。

    ソースと継承

メソッド

  • 検証付きポインターアダプターで要素パラメーターを読みます。

    引数

    name
    string

    ネイティブパラメーター名。

    defaultValue
    null | Element = null

    有効な既定要素または null。既定値は null。

    戻り値

    null | Element

    一意の要素。ネイティブ変換に失敗した場合は既定値。

    ScriptInterface 要素値と上流の drag_element 契約に対応し、 任意ポインターは拒否します。毎回有効性を検証し、永続属性へ保存しません。 コピーの変更は有効なパラメーターを変えません。

    ソースと継承
  • Rml::Event::GetParameter の型変換。ネイティブイベントが有効な間使えます。

    型パラメーター

    引数

    name
    string

    ネイティブパラメーター名。

    defaultValue

    T を選ぶ非 null の所有 Variant。

    戻り値

    ネイティブ変換結果。パラメーターがなければ既定値。

    JS コピーと独立した投影済みパラメーターを読みます。number は double、 BigInt は int64、INT64_MAX を超える場合は uint64 を選択します。 非数値文字列の数値変換は 0。整数範囲外は例外です。 scriptinterface は保護された Element、Context、Event 参照を読み、 ネイティブ参照の期限が切れると null になります。 ベクトルと色はコピーです。値の保持には parameters を使います。

    ソースと継承
  • ネイティブ GetScriptObject を読み、未登録イベントなら null。

    戻り値

    null | object

    登録ホストまたは null。期限切れの借用コールバックは例外。

    ソースと継承
  • ScriptInterface::IsClass でネイティブ Event の継承を調べます。

    引数

    identifier

    このモジュールの不透明型トークン。

    戻り値

    boolean

    有効なイベントが指定のネイティブ型を実装するかどうか。

    ソースと継承
  • 保持された型名または ID で Rml::Event の等価演算を行います。

    引数

    type
    string | number

    イベント名またはネイティブ ID。

    戻り値

    boolean

    指定された型のイベントかどうか。

    ソースと継承
  • ネイティブ削除関数で有効な所有イベントを解放します。

    戻り値

    void

    Factory と直接生成に対応し、借用コールバックは拒否します。 コピーは読めます。GC と終了でも削除し、安全な境界で解放を通知します。

    ソースと継承
  • マウス座標投影を含む SetCurrentElement を呼びます。

    引数

    element
    null | Element

    有効な現在要素、または null。

    戻り値

    void
    ソースと継承
  • SetPhase を呼び、検証後に保持した段階を更新します。

    引数

    phase

    None、Capture、Target、Bubble の段階。

    戻り値

    void
    ソースと継承
  • 有効なネイティブイベントに管理スクリプトを登録します。

    引数

    object
    null | object

    ホストオブジェクト。null は関連付けを解除します。

    戻り値

    void

    リスナー間で関連付けを共有します。借用は各コールバック後に失効し、 所有イベントの循環は回収できます。

    ソースと継承
  • Rml::Event::StopImmediatePropagation。同じ要素の残りのリスナーも停止。

    戻り値

    void
    ソースと継承
  • Rml::Event::StopPropagation。現在の DOM 階層のリスナーは完了します。

    戻り値

    void
    ソースと継承

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