Ray Low Level API

Der Low Level API (Engine.*) ist für die vielseitige Erstellung von 2D-Spielen konzipiert.

Jede API-Funktion benötigt einen Parameter. Der Parameter muss ein Wörterbuch sein und Argumente müssen als Schlüssel-Wert-Paare gespeichert werden.

Skelton

// Definieren Sie keine Variablen außerhalb von Funktionen, da es sich um einen Syntaxfehler handelt.

// Wird aufgerufen, wenn das Fenster erstellt wird.
func setup() {
    // Gibt die Fensterkonfiguration zurück.
    return {
        width: 1280,
        height: 720,
        title: "My First Game"
    };
}

// Wird einmal aufgerufen, wenn das Spiel beginnt.
func start() {
    // Hier sollten globale Variablen definiert werden.
    posX = 0;
    posY = 0;

    // Erstellen Sie eine weiße 100x100-Textur.
    tex = Engine.createColorTexture({
        width: 100,
        height: 100,
        r: 255, g: 255, b: 255, a: 255
    });
}

// Jeder Frame wird vor dem Rendern aufgerufen.
func update() {
    posX = Engine.mousePosX;
    posY = Engine.mousePosY;
}

// Jeder Frame wird aufgerufen, um Grafiken zu rendern.
func render() {
    Engine.draw({ texture: tex, x: posX, y: posY });
}

Debuggen

drucken()

Diese API gibt eine Zeichenfolge aus oder gibt ein Objekt aus. Akzeptiert nur ein Nicht-Wörterbuch-Argument.

func dumpEnemies() {
    if (Engine.isGamepadXPressed) {
        print("[Current emenies]");
        print(enemies);
    }
}

Zeit

Absolute Zeit

func update() {
    // Rufen Sie die Sekunden seit dem letzten Anruf ab.
    var curTime = Engine.millisec;
    var dt = (curTime - lastTime) * 0.001;
    lastTime = curTime;

    updateCharacters(dt);
}

Engine.getDate()

Gibt ein Datumswörterbuch zurück.

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;
}

Eingang

Dies sind Variablen, keine Funktionen.

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

Rendern

Engine.createColorTexture()

Diese API erstellt eine Textur mit der angegebenen Farbe und gibt eine Textur zurück.

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

Engine.loadTexture()

Diese API lädt eine Textur aus Assets und gibt eine Textur zurück.

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

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

Engine.destroyTexture()

Diese API zerstört eine Textur.

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

Engine.renderTexture()

Diese API rendert eine Textur auf dem Bildschirm.

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()

Diese API rendert eine Textur auf dem Bildschirm (eine einfachere Version von __TECH0__).

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

Engine.renderTexture3D()

Diese API rendert eine Textur auf dem Bildschirm.

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()

Diese API lädt eine Asset-Schriftartdatei in einen angegebenen Schriftarten-Slot.

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

Engine.createTextTexture()

Diese API erstellt eine Textur und zeichnet einen Text darauf.

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

Klang

Engine.playSound()

Diese API startet die Wiedergabe einer Sound-Asset-Datei auf einer angegebenen Soundspur.

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

Engine.playSoundLoop()

Diese API startet die Wiedergabe einer Sound-Asset-Datei auf einer angegebenen Soundspur.

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

Engine.stopSound()

Diese API stoppt die Tonwiedergabe auf einer bestimmten Tonspur.

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

Engine.setSoundVolume()

Diese API legt die Lautstärke für eine bestimmte Tonspur fest.

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

Daten speichern

Engine.writeSaveData()

Diese API schreibt einen Speicherdatenwert, der einer Schlüsselzeichenfolge entspricht. Wenn der Speicherdatenwert zu groß ist, schlägt diese API fehl.

Engine.readSaveData()

Diese API liest den Speicherdatenwert, der einer Schlüsselzeichenfolge entspricht. Der Rückgabewert ist ein Objekt, das einen gespeicherten Datenwert darstellt. Diese API schlägt fehl, wenn der angegebene Schlüssel nicht verfügbar ist.

Engine.checkSaveData()

Diese API prüft, ob die Speicherdaten für eine Schlüsselzeichenfolge vorhanden sind oder nicht. Der Rückgabewert ist ein boolescher Wert.