diff options
| author | Benoit Bolsee <benoit.bolsee@online.be> | 2009-05-18 01:50:31 +0400 |
|---|---|---|
| committer | Benoit Bolsee <benoit.bolsee@online.be> | 2009-05-18 01:50:31 +0400 |
| commit | 9a40f4d2a63183edb741bd5280b27aa068773d92 (patch) | |
| tree | 4554f06e903f251fc4e165263135d27b758cf2b5 /source/gameengine/PyDoc | |
| parent | 9ce8a676906b6b07b0971f0d5886ae338d188629 (diff) | |
BGE: bookmark option on controller to make them run before all other controllers.
A new bookmark button is available on the controller UI.
When set, the controller is guaranteed to execute before all
other non-bookmarked controllers, provided it is scheduled
for execution.
This is useful for initialization scripts that run once at startup or
scripts that must set some prerequisite for the other controllers at
the start of each logic frame.
This feature is also available at python level with the "bookmark"
attribute. It can be changed during the game.
Note that if several script are bookmarked, their relative order of
execution is not guaranteed. Make sure they don't depend on each other.
Diffstat (limited to 'source/gameengine/PyDoc')
| -rw-r--r-- | source/gameengine/PyDoc/GameTypes.py | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/source/gameengine/PyDoc/GameTypes.py b/source/gameengine/PyDoc/GameTypes.py index 3a6c62e7d23..ca02b1a2798 100644 --- a/source/gameengine/PyDoc/GameTypes.py +++ b/source/gameengine/PyDoc/GameTypes.py @@ -240,6 +240,10 @@ class SCA_IController(SCA_ILogicBrick): - note: the sensors are not necessarily owned by the same object. - note: when objects are instanced in dupligroups links may be lost from objects outside the dupligroup. @type actuators: sequence supporting index/string lookups and iteration. + @ivar bookmark: the bookmark option. + If set, the controller executes always before all other non-bookmarked controllers. + - note: Order of execution between bookmarked controllers is not guaranteed. + @type bookmark: bool """ #{ Deprecated def getState(): |