D2BS
Public Member Functions | Public Attributes

D2BSScript Class Reference

Represents a script (a thread), created by either loading a file, or typing something in the console. More...

List of all members.

Public Member Functions

bool getNext ()
 Get the next script.
void pause ()
 Pause the script.
void resume ()
 Resume the script.
void join ()
 Wait for other script to finish.
void stop ()
 Stop the script.
void send (...)
 Send some values to the script.

Public Attributes

String name
 The relative filename of the script.
int type
 The type of script.
bool running
 Whether or not the script is running.
int threadid
 The thread id.

Detailed Description

Represents a script (a thread), created by either loading a file, or typing something in the console.


Member Function Documentation

bool D2BSScript::getNext ( )

Get the next script.

Returns:
Whether there was another script or not.
void D2BSScript::send (   ...)

Send some values to the script.

Has the effect of calling the any listeners to scriptmsg with the parameters provided.


Member Data Documentation

The relative filename of the script.

If the script is from the console the filename will be reported as "Command Line".

The type of script.

0 - InGame

1 - OutOfGame or Command