Akashic Engine
    Preparing search index...

    Interface FrameSpriteParameterObject

    FrameSprite のコンストラクタに渡すことができるパラメータ。 各メンバの詳細は FrameSprite の同名メンバの説明を参照すること。

    interface FrameSpriteParameterObject {
        anchorX?: null | number;
        anchorY?: null | number;
        angle?: number;
        children?: E[];
        compositeOperation?: CompositeOperationString | CompositeOperation;
        frameNumber?: number;
        frames?: number[];
        height: number;
        hidden?: boolean;
        id?: number;
        interval?: number;
        local?: boolean;
        loop?: boolean;
        opacity?: number;
        parent?: Scene | E;
        scaleX?: number;
        scaleY?: number;
        scene: Scene;
        shaderProgram?: ShaderProgram;
        src: Surface | ImageAsset;
        srcHeight?: number;
        srcWidth?: number;
        srcX?: number;
        srcY?: number;
        tag?: any;
        touchable?: boolean;
        width: number;
        x?: number;
        y?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    anchorX?: null | number

    オブジェクトのアンカーの横位置。アンカーについては以下の通り。

    • アンカーとして設定した箇所がこのオブジェクトの基点 (位置、拡縮・回転の基点) となる。
    • 単位は相対値 (左上端が (0, 0) 中央が (0.5, 0,5) 右下端が (1,1) ) である。 初期値は 0 である。

    NOTE: anchorX または anchorY のどちらかを明示的に null に指定した場合、 このオブジェクトのアンカーは前バージョン(v2.x.x 以前)のデフォルトの挙動 (位置 x, y は左上端を基準に、拡大・縮小・回転の基点は中央を基準に決定) と同様になる。 これは前バージョンとの後方互換性のために存在する。 *

    0
    
    anchorY?: null | number

    オブジェクトのアンカーの縦位置。アンカーについては以下の通り。

    • アンカーとして設定した箇所がこのオブジェクトの基点 (位置、拡縮・回転の基点) となる。
    • 単位は相対値 (左上端が (0, 0) 中央が (0.5, 0,5) 右下端が (1,1) ) である。 初期値は 0 である。

    NOTE: anchorX または anchorY のどちらを明示的に null に指定した場合、 このオブジェクトのアンカーは前バージョン(v2.x.x 以前)のデフォルトの挙動 (位置 x, y は左上端を基準に、拡大・縮小・回転の基点は中央を基準に決定) と同様になる。 これは前バージョンとの後方互換性のために存在する。 *

    0
    
    angle?: number

    オブジェクトの回転。度数で指定する。

    0
    
    children?: E[]

    このエンティティの全子エンティティ。

    undefined
    

    描画時の合成方法を指定する。 省略された場合、合成方法を指定しない(親の合成方法を利用する)。 なお CompositeOperation での指定は非推奨である。 CompositeOperationString を利用すること。

    undefined
    
    frameNumber?: number

    最初に表示される画像片のインデックス。 start() 呼び出しによりタイマーで自動的に書き換えられていくが、ゲーム開発者が明示的に値を設定してもよい。

    0
    
    frames?: number[]

    アニメーションの内容。

    アニメーションの各フレームでの表示内容を指定するインデックスの配列を指定する。 インデックスは、コンストラクタに渡された画像を幅 srcWidth, 高さ srcHeight 単位の小さな画像(画像片)の集まりであるとみなして、 各画像片を特定する値である。左上の画像片を 0, その右隣の画像片を 1 として左上から右下に順に割り振られる。

    [0]
    
    height: number

    このエンティティの高さ

    hidden?: boolean

    このエンティティの表示状態。

    false
    
    id?: number

    このエンティティに割り振られる E#id の値。 エンジンが一意の ID を設定するため、通常指定する必要はない。 この値は、スナップショットローダがエンティティを復元する際にのみ指定されるべきである。

    undefined
    
    interval?: number

    アニメーションの更新頻度(ミリ秒)。 省略された場合、 start() 時にFPSの逆数に設定される。(つまり、1フレームごとに画像が切り替わっていく)

    (1000 / game.fps)
    
    local?: boolean

    このエンティティがローカルであるか否か。 コンストラクタで真が指定された時、または属するシーンがローカルシーンまたはローカルティック補間シーンである時、この値は真である。

    この値が真である場合、このエンティティに対する point イベントはこのゲームインスタンスにのみ通知され、 他の参加者・視聴者には通知されない。また真である場合、 id の値の一意性は保証されない。

    false
    
    loop?: boolean

    アニメーションをループ再生させるか否か。

    true
    
    opacity?: number

    0~1でオブジェクトの不透明度を表す。 この値が0の場合、Rendererは描画処理を省略する。

    1
    
    parent?: Scene | E

    このエンティティの親

    undefined
    
    scaleX?: number

    オブジェクトの横方向の倍率。

    1
    
    scaleY?: number

    オブジェクトの縦方向の倍率。

    1
    
    scene: Scene

    このエンティティが属するシーン。

    shaderProgram?: ShaderProgram

    このエンティティの描画時に利用されるシェーダプログラム。 このエンティティの renderer#isSupportedShaderProgram() が偽を返した場合、 renderer#setShaderProgram() は呼ばれないことに注意。

    また g.FilledRect やその親エンティティに本値を指定した場合、対象の g.FilledRect の描画結果は不定である。 これは実装上の制限に基づく現バージョンの仕様である。

    この値に undefined を指定した場合、親のシェーダプログラムを利用する。 この値に null を指定した場合、明示的にデフォルトのシェーダプログラムを利用する。

    undefined
    

    画像として使う Surface または ImageAsset

    srcHeight?: number

    surface の描画対象部分の高さ。 描画はこの値を this.height に拡大または縮小する形で行われる。 省略された場合、値に height があれば height 、なければ src.height

    height || src.height
    
    srcWidth?: number

    surface の描画対象部分の幅。 描画はこの値を this.width に拡大または縮小する形で行われる。 省略された場合、値に width があれば width 、なければ src.width

    width || src.width
    
    srcX?: number

    surface の描画対象部分の左端。

    0
    
    srcY?: number

    surface の描画対象部分の上端。

    0
    
    tag?: any

    ゲーム開発者向けのタグ情報管理コンテナ。 この値はゲームエンジンのロジックからは使用されず、ゲーム開発者は任意の目的に使用してよい。

    undefined
    
    touchable?: boolean

    プレイヤーにとって触れられるオブジェクトであるかを表す。 この値が偽である場合、ポインティングイベントの対象にならない。

    false
    
    width: number

    このエンティティの幅

    x?: number

    このオブジェクトの横位置。実際の座標位置はscaleX, scaleY, angle, anchorX, anchorYの値も考慮する必要がある。

    0
    
    y?: number

    このオブジェクトの縦位置。実際の座標位置はscaleX, scaleY, angle, anchorX, anchorYの値も考慮する必要がある。

    0