The Commodore 64 3D and VR Emulator Home Introduction Features Screenshots Download Links Help About

www.icons8.com

Overview

The new version of YACE supports Angelscript scripting. The script is also used for the 3D and VR transformation - here you can define your 3D scene and manipulate all visual objects (see 3D/VR tutorial).
Also it is possible to change or extend the gameplay or automate and manipulate user input like key press. Adding simple AI is also possible.

Many things can also be automated using the command console and the complex breakpoints to trigger actions.
Script and console command can also be used together, e.g. setting conditional actions or breakpoint from the script or reacting on them in the script.

Description

The scripting language Angelscript is quite easy to understand - it's like C++ without pointers.

Angelscripts can be loaded from the library or the file dialog. The global part of the script is executed directly on loading.
When starting YACE64 the script "Default.as" is loaded automatically, it just contains some samples.

When the script contain errors a message on the screen appears. The detailed script logging can be found in the file YACE.log within the emulator path. There will errors and warings be written. So if something doesn't work as expected, first have a look in this file. The file will be overridden on every start of YACE.

Note: If you are missing a function or callback, please contact me - most things can be added shortly.

YACE64 can call function within the script; currently the following are supported:

Callbacks

Callbacks are function, that are called from emulator, when defined in the script. For performance reasons only define functions that you need.

Global Functions

Objects

This are the following static objects, that are provided by YACE64:

APP

E3D

C64

D8, D9 (Discdrive 8 or 9)

GUI

VIC

SID

VR

ParticleEffect

Types and enums

Example etup"

const int startProgramTimerId = 1;

// Setting up the emulator with loading a program and initialising a complex 3D scene
void OnLoad(bool reloaded)
{
    string scriptPath = APP.GetScriptPath(); // get the path, where this script is located

    APP.SetPAL(); // Set PAL timing for our "game"

    APP.ClearDepthMaps(); // Clear all loaded depth maps
    APP.ClearModels(); // Clear all loaded model

    // Set the view mode to the new 3D mode
    APP.ViewMode = ViewMode::Ext3D;

    // Set the ambient light color and brigtness of 3D mode
    APP.SetAmbientLight(0.3, 0.3, 0.3);

    // Set the direction of the light (from the middle off the scene (x), from top to bottom (y) and back to forth (z))
    APP.SetLightDir(0.0, -1.0, +1.0);

    // Position the 3D scene on the screen
    E3D.SetScenePosition(0.24, -0.35, -0.1);

    // Rotate the 3D scene a little bit
    E3D.SetSceneOrientation(-25.0, -15.0, 0.0, 0.0);

    if (!reloaded) // if this script is reloaded, we don't want to load the program again
    {
        // Load a program, that is located in the same path as the this script
        APP.Load(scriptPath + "Sprites.prg", 0);
        // Set a timer, that triggers the program to run
        SetTimer(startProgramTimerId, 120, false);
    }
}

void OnTimer(int timerId)
{
    if (timerId == startProgramTimerId)
    {
        APP.SendASCII("RUN\n");
    }
}

Example "Conditions"

void OnLoad(bool reloaded)
{
    // Will always call OnCondition(), when the rasterline 30 is reached
    C64.SetCondition(1, { "VIC.RL=30" }, "Rasterline 30"); // see breakpoint for a lot of possible conditions
}

void OnCondition(int device, int conditionId, string data)
{
    // Will show the message "OnCondition(1, Rasterline 30)" on the screen
    GUI.ShowInfoMessage("OnCondition(" + formatInt(conditionId) + ", " + data + ")");

    // Uncomment the following line, to clear the condition 1, when rasterline 30 has been reached the first time after SetCondition()
    //C64.ClearCondition(1);
}

Example "Buttons"

float audioEmitterX = 0.0

void OnLoad(bool reloaded)
{
    APP.Audio3D = true; // Enable 3D audio

    GUI.SetButtonTitle(1, "Audio +X");    // Name the button 1
    GUI.SetButtonTitle(2, "Audio -X");    // Name the button 2
}

void OnUser(int buttonIndex)
{
    if (buttonIndex == 1)
    {
        // Move SID audio position to the right
        audioEmitterX += 0.2f;
        APP.SetAudioEmitter(AudioEmitter::SID, audioEmitterX, 0.0, 0.5);
    }
    else if (buttonIndex == 2)
    {
        // Move SID audio position to the left
        audioEmitterX -= 0.2f;
        APP.SetAudioEmitter(AudioEmitter::SID, audioEmitterX, 0.0, 0.5);
    }
}


/*
function onCondition(conditionId, device, data) -- when a system triggered a condition then do:
    --rl = VIC.Rasterline
    x = C64:Read(0xbc01) + (C64:Read(0xbc02) * 256)     -- read the player postion of a S.E.U.C.K game
    y = C64:Read(0xbc03)
    xd = (x - 150.0) / 120.0                            -- do some calculations
    zd = (y / 55.0) - 3.5
    vert = -0.6 * (1.0-(y / 200.0))
    VR:SetScenePosition(xd + relCalibratedPosX, vert + relCalibratedPosY, zd + relCalibratedPosZ) -- Set the 3D scene position (x, y, z in meter)
    VR:SetSceneOrientation(sceneYaw, scenePitch, sceneRoll, sceneSpeed) -- Set the 3D scene orientation (yaw, pitch, roll in degree)
end
*/

Example "Keyboard and Timer"

const int runProgramTimerId = 1; // declare some identifiers for our timers
const int startProgramTimerId = 2;

void OnLoad(bool reloaded)
{
    // start a timer, that will send the "RUN" command after some time (e.g. to start a previous loaded game)
    SetTimer(runProgramTimerId , 125, false);   // start a timer, that will call OnTimer() after 125 frame (~2.5s)

    // start a second timmer that will later press a cursor- and the space key (e.g. to select or start something in the game menu)
    SetTimer(startProgramTimerId , 500, false); // start a timer, that will call OnTimer() after 500 frame (~10.0s)
}

void OnTimer(int timerId)
{
    if (timerId == runProgramTimerId)
    {
        APP.SendASCII("RUN\n");    // send a simple ASCII text to the keyboard (c-style strings)
    }
    else if (timerId == startProgramTimerId)
    {
        array<CbmKeyState> b(4); // declare four keyboard action

        b[0].key = Keys::CrsrDown; b[0].pressed = true;
        b[1].key = Keys::CrsrDown; b[1].pressed = false;

        b[2].key = Keys::Space; b[2].pressed = true;
        b[3].key = Keys::Space; b[3].pressed = false;

        APP.SendCbmKeys(b); // send more complex keyboard actions, which are not possible with SendASCII()
    }
}

Example "Joystick and Keyboard callback"

void OnKeyboard(bool pressed, Keys cbmKeyboard)
{
    if (cbmKeyboard == Keys::Space)
        GUI.ShowInfoMessage("OnKeyboard Space "+ (pressed ? "pressed": "released"));
    else
        GUI.ShowInfoMessage("OnKeyboard $" + formatInt(cbmKeyboard, "0H", 4) + " " + (pressed ? "pressed" : "released"));
}

void OnJoystick(int port, JoystickContact contactMask)
{
    if (contactMask == JoystickContact::Up)
        GUI.ShowInfoMessage(formatInt(port) + " OnJoystick Up");
    else
        GUI.ShowInfoMessage(formatInt(port) + " OnJoystick $" + formatInt(contactMask, "0H", 2));
}