PyClientApp - KBEngine bots

KBEngine API

KBEngine

PyClientApp class

[KBEngine module]

PyClientApp is a part of the KBEngine Module. It is is client object created when a client is simulated from the bottom of C++. It cannot be created in the script layer directly.

Member functions

def getSpaceData( key ):

Callbacks

def onDestroy( self ):
def onEnterWorld( self ):
def onLeaveWorld( self ):
def onEnterSpace( self ):
def onLeaveSpace( self ):

Attributes

id  Read-only Integer
entities  Entities

A detailed description

Instances of class Entity represent game objects on the client.



An Entity can access its equivalent entities in the base and cell applications via ENTITYCALL. This requires a set of remotely-invoked functions (specified in the entity's .def file).

Member functions documentation

def getSpaceData( key ):

Function description:

Get the space data of the specified key.
The space data is set by the user on the server through setSpaceData.

parameters:

key string, a string keyword.

returns:

string, string data for the key


Callback functions documentation

def onDestroy( self ):

Called when the entity is destroyed.

def onEnterWorld( self ):

If the entity is not a client-controlled entity, it indicates that the entity has entered the View scope of the entity controlled by the client on the server side. At this time, the client can see the entity.
If this entity is a client-controlled entity, it indicates that the entity has created a cell on the server and entered space.

def onLeaveWorld( self ):

If the entity is not a client-controlled entity, it indicates that the entity has entered the View scope of the entity controlled by the client on the server side. At this time, the client can see this entity.
If the entity is a client-controlled entity, it indicates that the entity has created a cell on the server and entered space.

def onEnterSpace( self ):

The client-controlled entity enters a new space.

def onLeaveSpace( self ):

The client-controlled entity leaves the current space.

Attributes documentation

entities

Description:

entities is a dictionary object that contains all the entities in the current process.

Types:

Entities