This repository has been archived on 2023-10-09. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
blender-archive/source/gameengine/PyDoc/SCA_ILogicBrick.py
Campbell Barton dee32d0b3f BGE Python API
- initialize pythons sys.argv in the blenderplayer
- ignore all arguments after a single " - " in the blenderplayer (like in blender), so args can be passed to the game.
- add a utility function PyOrientationTo() - to take a Py euler, quat or 3x3 matrix and convert into a C++ MT_Matrix3x3.
- add utility function ConvertPythonToMesh to get a RAS_MeshObject from a KX_MeshProxy or a name.
- Added error prefix arguments to ConvertPythonToGameObject, ConvertPythonToMesh and PyOrientationTo so the error messages can include what function they came from.
- deprecated brick.getOwner() for the "owner" attribute.
2009-04-20 09:13:59 +00:00

46 lines
1.3 KiB
Python

# $Id$
# Documentation for the logic brick base class SCA_ILogicBrick
from KX_GameObject import *
class SCA_ILogicBrick:
"""
Base class for all logic bricks.
@ivar executePriority: This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first).
@type executePriority: int
@ivar owner: The game object this logic brick is attached to (read only).
@type owner: L{KX_GameObject<KX_GameObject.KX_GameObject>} or None in exceptional cases.
"""
def getOwner():
"""
Gets the game object associated with this logic brick.
Deprecated: Use the "owner" property instead.
@rtype: L{KX_GameObject<KX_GameObject.KX_GameObject>}
"""
#--The following methods are deprecated--
def setExecutePriority(priority):
"""
Sets the priority of this logic brick.
This determines the order controllers are evaluated, and actuators are activated.
Bricks with lower priority will be executed first.
Deprecated: Use the "executePriority" property instead.
@type priority: integer
@param priority: the priority of this logic brick.
"""
def getExecutePriority():
"""
Gets the execution priority of this logic brick.
Deprecated: Use the "executePriority" property instead.
@rtype: integer
@return: this logic bricks current priority.
"""