diff options
| -rw-r--r-- | CHANGELOG.md | 3 | ||||
| -rw-r--r-- | entityx/python/README.md | 7 | ||||
| -rwxr-xr-x | scripts/travis.sh | 2 |
3 files changed, 7 insertions, 5 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index ae58255..89c92d8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,6 @@ Two big changes in this release: 1. Python scripting support (alpha). - - Bridges the EntityX entity-component system into Python. - Components and entities can both be defined in Python. - Systems must still be defined in C++, for performance reasons. @@ -14,4 +13,4 @@ Two big changes in this release: See the [README](https://github.com/alecthomas/entityx/blob/master/entityx/python/README.md) for help, and the [C++](https://github.com/alecthomas/entityx/blob/master/entityx/python/PythonSystem_test.cc) and [Python](https://github.com/alecthomas/entityx/tree/master/entityx/python/entityx/tests) test source for more examples. -2. Updated the build system to +2. Made the build system much more robust, including automatic feature selection with manual override. diff --git a/entityx/python/README.md b/entityx/python/README.md index be543fb..f4f6aa2 100644 --- a/entityx/python/README.md +++ b/entityx/python/README.md @@ -8,13 +8,16 @@ Planned features that are currently unimplemented: - Emitting events from Python. -## Concepts +## Design - Python scripts are attached to entities with `PythonComponent`. +- Systems and components can not be created from Python, primarily for performance reasons. - Events are proxied directly to Python entities via `PythonEventProxy` objects. + - Each event to be handled in Python must have an associated `PythonEventProxy`implementation. + - As a convenience `BroadcastPythonEventProxy<Event>(handler_method)` can be used. It will broadcast events to all `PythonComponent` entities with a `<handler_method>`. - `PythonSystem` manages scripted entity lifecycle and event delivery. -## Overview +## Summary To add scripting support to your system, something like the following steps should be followed: diff --git a/scripts/travis.sh b/scripts/travis.sh index 3244b82..dadc478 100755 --- a/scripts/travis.sh +++ b/scripts/travis.sh @@ -12,4 +12,4 @@ fi cmake ${CMAKE_ARGS} make VERBOSE=1 -make test +make test || cat Testing/Temporary/LastTest.log |