UOX3 Script Engine

API and Event handling

Console Related Methods

Print
Prototype
void Print( string );
Purpose Note: Include \n at the end of the string unless you're sending multiple messages
Example of Usage
console.Print( "Hello World!\n" );
Log
Prototype
void Log( string );
void Log( string, filename );
Purpose Note: Include \n at the end of the string unless you're sending multiple messages
Optional second parameter is the name of the file to log the message into
Example of Usage
console.Log( "I found an error, and I'm logging it!" );
Error
Prototype
void Error( errorLvl, string );
Purpose-
Example of Usage
-
Warning
Prototype
void Warning( warningLvl, string );
Purpose-
Example of Usage
-
PrintSectionBegin
Prototype
void PrintSectionBegin();
Purpose-
Example of Usage
console.PrintSectionBegin();
TurnYellow
Prototype
void TurnYellow();
Purpose-
Example of Usage
console.TurnYellow();
TurnRed
Prototype
void TurnRed();
Purpose-
Example of Usage
console.TurnRed();
TurnGreen
Prototype
void TurnGreen();
Purpose-
Example of Usage
console.TurnGreen();
TurnBlue
Prototype
void TurnBlue();
Purpose-
Example of Usage
TurnBlue();
TurnNormal
Prototype
void TurnNormal();
Purpose-
Example of Usage
console.TurnNormal();
TurnBrightWhite
Prototype
void TurnBrightWhite();
Purpose-
Example of Usage
console.TurnBrightWhite();
PrintDone
Prototype
void PrintDone();
Purpose-
Example of Usage
console.PrintDone();
PrintFailed
Prototype
void PrintFailed();
Purpose-
Example of Usage
console.PrintFailed();
PrintPassed
Prototype
void PrintPassed();
Purpose-
Example of Usage
console.PrintPassed();
ClearScreen
Prototype
void ClearScreen()
Purpose Clear the console screen
Example of Usage
console.ClearScreen();
PrintBasedOnVal
Prototype
void PrintBasedOnVal( boolean );
Purpose Console will say pass/fail based on boolean (true/false)
Example of Usage
console.PrintBasedOnVal( true );
MoveTo
Prototype
void MoveTo( x, y );
Purpose NOTE: If you want the same line, y == -1
Example of Usage
console.MoveTo( 100, 100 );
PrintSpecial
Prototype
void PrintSpecial( textColour, string );
Purpose-
Example of Usage
-
BeginShutDown
Prototype
void BeginShutdown();
Purpose Start the UOX3 shutdown sequence
Example of Usage
console.BeginShutdown();
Reload
Prototype
void Reload( type )
Purpose

Reload something from console. Available types:
0 Reload INI
1 Reload Accounts
2 Reload Regions
3 Reload Spawn Regions
4 Reload Spells
5 Reload Commands
6 Reload Definition Files
7 Reload JS
8 Reload HTML

Example of Usage
console.Reload( 4 ); //Reloads spells
ęCopyright 2000-2001 WWW.UOX3.NET (Daniel Stratton/Matthew Randall)