Difference between revisions of "Client script"

Latest revision as of 20:44, 3 February 2010

The Resource Palette Art Resources Animations Level Layouts Materials Models Morphs Visual Effects FaceFX Sound and music Designer Resources Module Area Area list Character Client script Conversation Creature Cutscene Item Map Merchant Placeable Plot Script Sound Stage Trigger File Types 2DA file GFF file

Client Scripts are used to automate client behavior and are intended primarily for debugging use.

The virtual machine that runs client scripts is not included with the ship build of the game, so this resource is likely to be of no practical use.

Client Scripting Wait Commands

The client scripting language supports 2 built in commands for pausing a script:

• void WaitFor(float fTime) - Pauses the script for fTime seconds
• void WaitUntil(int bCondition) - Pauses the script until bCondition == true

A script that is paused on a WaitUntil command will timeout after a default of 30 seconds. This time-out can be modified using the void SetWaitTimeout(float fTime) command.

void main()
{
    LoadModule( "Sniff Test" );
    PrintToScreen("Loading...");
    WaitUntil( IsModuleLoaded() );
    PerformUseObject( oPlayer, oDoor );
    WaitFor(10.0f);
    if (GetDistanceBetweenObjects(oPlayer, oDoor) < 4.0f)
    {
        PrintToScreen("Player moved to door");
    }
}