Module GameLogic

source code

Documentation for the GameLogic Module.

There are only four importable modules in the game engine:

• GameLogic
• GameKeys
• Rasterizer
• Mathutils - Borrowed from Blender.Mathutils

All the other modules are accessible through the methods in GameLogic.

See WhatsNew for updates, changes and new functionality in the Game Engine Python API.

Examples:

       # To get the controller thats running this python script:
       co = GameLogic.getCurrentController() # GameLogic is automatically imported
       
       # To get the game object this controller is on:
       obj = co.getOwner()

KX_GameObject and KX_Camera or KX_Light methods are available depending on the type of object:

       # To get a sensor linked to this controller.
       # "sensorname" is the name of the sensor as defined in the Blender interface.
       # +---------------------+  +--------+
       # | Sensor "sensorname" +--+ Python +
       # +---------------------+  +--------+
       sens = co.getSensor("sensorname")

       # To get a list of all sensors:
       sensors = co.getSensors()

See the sensor's reference for available methods:

• DelaySensor
• JoystickSensor
• KeyboardSensor
• MouseFocusSensor
• MouseSensor
• NearSensor
• NetworkMessageSensor
• PropertySensor
• RadarSensor
• RandomSensor
• RaySensor
• TouchSensor

You can also access actuators linked to the controller:

       # To get an actuator attached to the controller:
       #                          +--------+  +-------------------------+
       #                          + Python +--+ Actuator "actuatorname" |
       #                          +--------+  +-------------------------+
       actuator = co.getActuator("actuatorname")
       
       # Activate an actuator
       GameLogic.addActiveActuator(actuator, True)

See the actuator's reference for available methods:

• ActionActuator
• AddObjectActuator
• CameraActuator
• CDActuator
• ConstraintActuator
• EndObjectActuator
• GameActuator
• IpoActuator
• NetworkMessageActuator
• ObjectActuator
• PropertyActuator
• RandomActuator
• ReplaceMeshActuator
• SceneActuator
• SoundActuator
• TrackToActuator
• VisibilityActuator

Most logic brick's methods are accessors for the properties available in the logic buttons. Consult the logic bricks documentation for more information on how each logic brick works.

There are also methods to access the current KX_Scene:

       # Get the current scene
       scene = GameLogic.getCurrentScene()
       
       # Get the current camera
       cam = scene.active_camera

Matricies as used by the game engine are row major:

       matrix[row][col] = blah

KX_Camera has some examples using matricies.