id (int) — Bot ID (read-only).

spaceID(int) — ID of the space the bot is currently in. 0 means not in any space (read-only).

loginName(string) — Bot's login name.

loginPassword(string) — Bot's login password.

tag (string) — Bot's user-specified tag. Allows the control of partial sets of bots.

speed (float) — Bot's speed.

position (Vector3) — Bot's position.

yaw (float) — Bot's yaw.

pitch (float) — Bot's pitch.

roll (float) — Bot's roll.

isOnline(bool) — Indicates whether the bot is connected to a server (read-only).

isDestroyed(bool) — Indicates whether the bot has been destroyed (read-only).

entities(PyObject)

Dictionary-like attribute containing the list of entities that are in the simulated client's current AOI.

logOn()

Initiate log on process for the simulated client to connect to a BW server.

logOff()

Make a simulate client disconnect from server gracefully. If the simulated client is not online, it will do nothing.

dropConnection()

Make a simulate client drop the connection with the server. If the simulated client is not online, it will do nothing.

setConnectionLossRatio( float lossRatio )

Set up network packet loss ratio for simulating unstable network environment. Range between 0.0 and 1.0. 0.0 means no packet loss. 1.0 mean 100 percent packet loss.

setConnectionLatency( float minLatency, float maxLatency )

Set up simulated network data latency (in milliseconds).

moveTo( Math.Vector3 position )

Set next destination position for the player avatar of the simulated client.

snapTo( Math.Vector3 position )

Set the player avatar position for the simulated client.

stop()

Stop the player avatar of the simulated client moving.

faceTowards( Math.Vector3 direction )

Set the direction of avatar of the simulated client.

addTimer()

Add a timer for the bot client. This function returns an integer timer id; otherwise it returns -1.

delTimer( int timerID )

deletes an active timer corresponding the timerID.

onTick()

This optional function is invoked every game tick, should it be defined in the player Avatar script.

bots

Dictionary-like attribute containing the list of simulated clients. The key is the player's ID, and value is an instance of ClientApp.

bots [<player_id>]. entities

Dictionary-like attribute containing the list of entities created under the simulated client specified by <player_id>. The key is the entity's ID, and the value is the reference to the entity.

In non-script bots, only the player entity is created and stored in this attribute.

bots [<player_id>].entities[<ent_id>].clientApp

Attribute referring to the ClientApp that owns the entity. An entity can access its owner ClientApp via this attribute. BigWorld.bots[<player_id>].entities[<ent_id>].clientApp equals to BigWorld.bots[<player_id>].

setMovementController(string type, string data) — Context: ClientApp

Sets a new movement controller for the bot. On failure, the controller is left unchanged. Returns true on success, false on failure.

setLoginMD5Digest(string MD5Digest) — Context: BigWorld

Set the 32 character long MD5Digest (in hex readable form) for server login. If the input string length is not exactly 32 character, the MD5 digest will be reset to empty.

addBots( int numBots ) — Context: BigWorld

Immediately adds the specified number of simulated clients to the application. If too many bots are added at once, then some of them may time out, depending on how long it takes to log in all of them.

addBotsSlowly(int numBots,float delayBetweenAdd,int groupSize=1) — Context: BigWorld

Adds bots to the system in groups of groupSize, and add a delay between each group. This method returns immediately, adding the bots in the background, and is the best way to add bots to a system.

addBotsWithName( PyObject loginInfo )

Immediately add a set of bots with login name and login password specified from loginInfo. The structure of the loginInfo is a list of tuples which consist of two strings. The first string is the login name and the second one is login password. In the event of incorrect loginInfo, a Python exception will be thrown.

delBots( int numBots) — Context: BigWorld

Deletes the specified number of simulated clients from the application. The method onClientAppDestroy() of the personality module is called.

getDefaultServer() — Context: BigWorld

Returns the server name that the bots try to log in.

setDefaultServer( string serverName ) — Context: BigWorld

Sets the server name that the bots try to log in.

onTick() — Context: BWPersonality

This optional function is invoked every game tick, should it be defined in the personality module in <res>/server/bw.xml.

onLoseConnection( int playerID ) — Context: BWPersonality

If this callback function is defined in the personality module specified in file <res>/server/bw.xml, it will be invoked when a simulated client loses its connection with a server abnormally. The personality script can decide whether the client should be destroyed or remain dormant for later reactivation by return True or False respectively. NOTE: if this callback is not defined, bots that lose connection will be automatically destroyed.

onClientAppDestroy( int playerID ) — Context: BWPersonality

If defined in the personality module specified in file <res>/server/bw.xml, this callback method is called for each destroyed bot client. The argument is the ID of the deleted player entity. A bot client may be destroyed due to either loss of server connection or by BigWorld.delBots() method call. If a bot client is destroyed by BigWorld.delBots() method call, it will be disconnected from the server gracefully. We recommend client should execute additional log off procedure in this onClientAppDestroy callback function. An example is as following:

def onClientAppDestroyed( playerID ):
  bot = BigWorld.bots[playerID]
  if bot.isOnline:
    bot.entities[playerID].base.logOff()

The implementation above assumes that the player entity on the server has an exposed base method logOff(), which will then destroy the player cell and base entities on the server. The script must to be placed under the script folder <res>/scripts/bot.