BGE: added bge.logic.{get,set}AnimRecordFrame functions
authorSybren A. Stüvel <sybren@stuvel.eu>
Tue, 25 Aug 2015 11:42:09 +0000 (13:42 +0200)
committerSybren A. Stüvel <sybren@stuvel.eu>
Tue, 25 Aug 2015 11:42:09 +0000 (13:42 +0200)
commitba5807c2710939cf8171fb19830f82cece48759f
tree77c7c9eddca6c63ff84850cd0db9f6bf485e660a
parent6f7eb623d3beaf7e49b5bb0d7686c2b2c714d867
BGE: added bge.logic.{get,set}AnimRecordFrame functions

By using getAnimRecordFrame(), game developers have access to the frame
number used by the "Record animation" feature. This enables them to
record additional information in Blender's F-Curves and ensuring perfect
synchronization with the information already recorded by Blender.

The setAnimRecordFrame() can be used to change the frame number at which
animations are recorded, for example to introduce delays the recording that
do not require delays in the actual game/simulation run.

The getter/setter functions in KX_KetsjiEngine are not directly named after
property they access (m_currentFrame). I found "current frame" to be too
vague for a public interface, hence chose a more descriptive name.

Reviewers: moguri, hg1, campbellbarton, panzergame, aligorith

Reviewed By: panzergame, aligorith

Differential Revision: https://developer.blender.org/D1449
doc/python_api/rst/bge.logic.rst
source/gameengine/Ketsji/KX_KetsjiEngine.cpp
source/gameengine/Ketsji/KX_KetsjiEngine.h
source/gameengine/Ketsji/KX_PythonInit.cpp