Ray Low Level API

Low Level API (Engine.*) は、汎用的な 2D ゲーム制作向けに設計されています。

すべての API 関数はたった 1 つの引数を受け取ります。 その引数は辞書オブジェクトでなければならず、関数に渡すそれぞれのオプションは、キーと値のペアとして辞書に格納する必要があります。 便宜上、そのオプションのことを、このドキュメントでは引数と表現しています。

骨組み

// 関数の外で変数を定義しないでください。構文エラーになります。

// ウィンドウが作成されたときに呼び出されます。
func setup() {
    // ウィンドウ設定を返します。
    return {
        width: 1280,
        height: 720,
        title: "My First Game"
    };
}

// ゲーム開始時に一度だけ呼び出されます。
func start() {
    // グローバル変数はここで定義してください。
    posX = 0;
    posY = 0;

    // 白い 100x100 のテクスチャを作成します。
    tex = Engine.createColorTexture({
        width: 100,
        height: 100,
        r: 255, g: 255, b: 255, a: 255
    });
}

// 描画前に毎フレーム呼び出されます。
func update() {
    posX = Engine.mousePosX;
    posY = Engine.mousePosY;
}

// グラフィックを描画するために毎フレーム呼び出されます。
func render() {
    Engine.draw({ texture: tex, x: posX, y: posY });
}

デバッグ

print()

この API は文字列を表示するか、オブジェクトをダンプします。 辞書ではない引数だけを取ります。

func dumpEnemies() {
    if (Engine.isGamepadXPressed) {
        print("[現在の敵]");
        print(enemies);
    }
}

時間

絶対時間

func update() {
    // 前回の呼び出しからの経過秒数を取得します。
    var curTime = Engine.millisec;
    var dt = (curTime - lastTime) * 0.001;
    lastTime = curTime;

    updateCharacters(dt);
}

Engine.getDate()

日付の辞書を返します。

func frame() {
    var date = Engine.getDate({});

    var year  = date.year;
    var month = date.month;
    var day   = date.day;
    var hour  = date.hour;
    var min   = date.minute;
    var sec   = date.second;
}

入力

これらは関数ではなく変数です。

func update() {
    if (Engine.isMouseLeftPressed) {
        player.x = player.x + 100;
    }
}

描画

Engine.createColorTexture()

この API は指定された色のテクスチャを作成し、テクスチャを返します。

func createBlockTexture() {
    blockTex = Engine.createColorTexture({
                   width:  16,
                   height: 16,
                   r:      255,
                   g:      255,
                   b:      255,
                   a:      255
               });
}

Engine.loadTexture()

この API はアセットからテクスチャを読み込み、テクスチャを返します。

func loadPlayerTexture() {
   playerTex = Engine.loadTexture({
                   file: "player.png"
               });

   var width = playerTex.width;
   var height = playerTex.height;
}

Engine.destroyTexture()

この API はテクスチャを破棄します。

func destroyPlayerTexture() {
    Engine.loadTexture({
        texture: playerTex
    });
}

Engine.renderTexture()

この API はテクスチャを画面に描画します。

func renderPlayer() {
    Engine.renderTexture({
        dstLeft:   playerPos.x,
        dstTop:    playerPos.y,
        dstWidth:  playerTex.width,
	dstHeight: playerTex.height,
        texture:   playerTex,
        srcLeft:   0,
        srcTop:    0,
        srcWidth:  playerTex.width,
        srcHeight: playerTex.height,
        alpha:     255
    });
}

Engine.draw()

この API はテクスチャを画面に描画します (Engine.renderTexture() の簡易版です)。

func renderPlayer() {
    Engine.draw({
        texture: playerTex,
        x:       playerPos.x,
        y:       playerPos.y
    });
}

Engine.renderTexture3D()

この API はテクスチャを画面に描画します。

func renderPlayer() {
    Engine.renderTexture({
        dstLeft:   playerPos.x,
        dstTop:    playerPos.y,
        dstWidth:  playerTex.width,
	dstHeight: playerTex.height,
        texture:   playerTex,
        srcLeft:   0,
        srcTop:    0,
        srcWidth:  playerTex.width,
        srcHeight: playerTex.height,
        alpha:     255
    });
}

Engine.loadFont()

この API はアセットのフォントファイルを指定されたフォントスロットに読み込みます。

func loadNotoSansFont() {
    Engine.loadFont({ slot: 0, file: "NotoSans.ttf" });
}

Engine.createTextTexture()

この API はテクスチャを作成し、その上にテキストを描画します。

func createScoreTexture() {
    scoreTex = Engine.createTextTexture({
                   slot: 0,
                   text: "Score: " + score,
                   size: 32,
                   r:    255,
                   g:    255,
                   b:    255,
                   a:    255
               });
}

サウンド

Engine.playSound()

この API は指定されたサウンドトラックでサウンドアセットファイルの再生を開始します。

func playJumpSound() {
    Engine.playSound({ stream: 0, file: "jump.ogg" });
}

Engine.playSoundLoop()

この API は指定されたサウンドトラックでサウンドアセットファイルのループ再生を開始します。

func playBGM() {
    Engine.playSoundLoop({ stream: 0, file: "jump.ogg" });
}

Engine.stopSound()

この API は指定されたサウンドトラックのサウンド再生を停止します。

func playJumpSound() {
    Engine.stopSound({ stream: 0 });
}

Engine.setSoundVolume()

この API は指定されたサウンドトラックの音量を設定します。

func playJumpSound() {
    Engine.setSoundVolume({
        stream: 0,
        volume: 1.0
    });
}

セーブデータ

Engine.writeSaveData()

この API はキー文字列に対応するセーブデータ値を書き込みます。 セーブデータ値が大きすぎる場合、この API は失敗します。

Engine.readSaveData()

この API はキー文字列に対応するセーブデータ値を読み込みます。 戻り値はセーブデータ値を表すオブジェクトです。 指定されたキーが利用できない場合、この API は失敗します。

Engine.checkSaveData()

この API はキー文字列に対応するセーブデータが存在するかどうかを確認します。 戻り値は真偽値です。