Низкоуровневый API Ray

Low Level API (Engine.*) предназначен для гибкого создания 2D-игр.

Каждая функция API принимает один параметр. Параметр должен быть словарем, а аргументы должны храниться в виде пар «ключ-значение».

Скелет

// Не определяйте переменные вне функций, потому что это синтаксическая ошибка.

// Вызывается при создании окна.
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 загружает текстуру из папки assets и возвращает текстуру.

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 загружает файл шрифта из папки assets в указанный слот шрифта.

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 начинает воспроизведение звукового файла из папки assets на указанной звуковой дорожке.

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

Engine.playSoundLoop()

Этот API начинает воспроизведение звукового файла из папки assets на указанной звуковой дорожке.

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 проверяет, существует ли сохранение данных для строкового ключа. Возвращаемое значение - логическое.