The bot instance. Bots can connect and login to a universe, enter a world, and interact with in-world elements like avatars and objects.
To make a bot connect to a universe and login, you must call at least the following two methods (in any order):
If the bot is to connect to a universe other than the main Activeworlds universe, you must call setUniverse before calling the two methods above.
To make a bot enter a world, you must also call setLocation. You may also call any of the following methods to affect the bot's appearance in-world:
| STATE_NONE | State value for universeConnection and worldConnection. |
| STATE_CONNECTED | State value for universeConnection and worldConnection. |
| STATE_DISCONNECTED | State value for universeConnection and worldConnection. |
| STATE_NOT_LOGGED_IN | State value for loggedIn. |
| STATE_LOGGED_IN | State value for loggedIn. |
| STATE_INVISIBLE | State value for visibility. |
| STATE_VISIBLE | State value for visibility. |
| id | The bot's ID number. | Read-only |
| instance | The bot's AW API instance pointer. | Read-only |
| universeConnection | State of the universe connection. | Read-only |
| loggedIn | State of the authentication. | Read-only |
| worldConnection | State of the world connection. | Read-only |
| visibility | State of the in-world visibility. | Read-only |
| events | Instance events controller. | Read-only |
| callbacks | Instance callbacks controller. | Read-only |
| attributes | Instance virtual attributes abstraction layer. | Read-only |
| setUniverse | Method description. |
| getUniverse | Method description. |
| setName | Method description. |
| getName | Method description. |
| setOwner | Method description. |
| getOwner | Method description. |
| setLocation | Method description. |
| getLocation | Method description. |
| setAvatar | Method description. |
| getAvatar | Method description. |
| setGesture | Method description. |
| getGesture | Method description. |
| setState | Method description. |
| getState | Method description. |
| destroy | Method description. |
Constant description.
Constant description.
public void ClassName::method1 ( void )
Method description.
Parameters:
None
Return Values:
None
public void ClassName::method2 ( [ int $a ] )
Method description.
Parameters: $a - A parameter. - DEFAULT: 0
Return Values:
The number you want.