CPSceneObjectContext

Makes the scene object with given ID the owner of the input keyboard focus.

Adds given scene object to the scene after this update cycle. Change will be visible only on the next frame update.

Adds new scene. Change will be visible only on the next frame update.

Gets the sequence of scene objects this object is colliding with. If no collisions are detected - this method returns an empty list.

NOTE: for a scene object to participate in the collision it must provide its collision shape. If scene object does not provide the collision shape (the default behavior) it will be ignored when checking for collision by other scene objects, and an exception will be thrown if such object initiates the check for the collision with itself.

Gets the sequence of scene objects colliding with given rectangular. If no collisions are detected - this method returns an empty list.

NOTE: for a scene object to participate in the collision it must provide its collision shape. If scene object does not provide the collision shape (the default behavior) it will be ignored when checking for collision by other scene objects, and an exception will be thrown if such object initiates the check for the collision with itself.

Gets the sequence of scene objects colliding with given coordinate. If no collisions are detected - this method returns an empty list.

NOTE: for a scene object to participate in the collision it must provide its collision shape. If scene object does not provide the collision shape (the default behavior) it will be ignored when checking for collision by other scene objects, and an exception will be thrown if such object initiates the check for the collision with itself.

Gets number of scene objects with given tags. All tags must be present in the scene object to be returned as part of the result sequence.

Deletes given scene object after this update cycle. Change will be visible only on the next frame update. Note that focus owner will be released if held by the deleted object.

Deletes given scene. Note that you can't delete current scene.

Exits the CPEngine.startGame method.

Gets camera control descriptor for the current scene.

Gets current camera frame. Camera frame is always a sub-region of the scene. In most cases, it is a smaller value between scene dimension and terminal dimension.

The canvas instance on which this scene object renders its content. In most cases, you should only render in CPSceneObject.render call.

Gets ID of the scene object owning the input focus, if any. If None - no object is owning the input focus and all objects will get input events.

ID of the scene object that is being processed.

Gets current frame's keyboard event.

Gets scene object with given ID.

Gets sequence of scene objects with given tags. All tags must be present in the scene object to be returned as part of the result sequence.

Gets the current owner of input keyboard focus.

Gets rendering statistics, if available.

Gets scene object with given ID. Throws CPException exception if object with given ID not found.

Checks whether the object this context is attached to is visible.

Gets direct messages send to this scene object, if any. Returns an empty sequence if no messages pending delivery. Note that sent messages are stored until they are retrieved or the scene is changed.

Releases the input focus if it is help by the object with given ID. No-op in all other cases.

Releases the input keyboard focus if it is held by the current scene object. No-op in all other cases.

Schedules given function to run at least delayMs milliseconds later or upon scene switch. Given function will only run if its timer elapses during the current scene or scene changes. Note that given function will run at the minimum the next frame and never in the current frame (even if delayMs is set to 1ms, for example).

Schedules given function to run at the next frame update. More specifically, this function will run before any of the scene objects updates on the next frame. Given function will only run if the next frame belongs to the same scene. In other words, at scene switch all currently pending functions will be discarded.

Sends direct message(s) to the scene object with given ID. Scene object must belong to the current scene, i.e. one cannot send a message to the scene objects from another scene. To exchange data between scenes you should use game cache. Note that messages will be available to recipient scene objects starting with the next frame. Messages will be stored until they are retrieved or the scene is changed.

Switches to the given scene. Note that switch will happen only after the current frame update cycle completes.

Makes the current scene object the owner of the input keyboard focus.

Deletes current scene object after this update cycle. Change will be visible only on the next frame update. Note that focus owner will be released if held by the this object.

Deletes scene objects with given tags. All tags must be present in the scene object to be deleted. Change will be visible only on the next frame update. Note that focus owner will be released if held by the deleted object.

Tests whether or not current object is a input keyboard focus owner.

Checks if the current frame's keyboard event, if any, contains given keyboard key.

Switches to the given scene as well as settings game cache parameters before the switch. Note that switch will happen only after the current frame update cycle completes.

Gets global frame count for the game.

Gets the timestamp in milliseconds for the current frame.

This value will be the same for all objects across all callbacks for the entirety of the current frame processing. It is used to provide the time simultaneity across all scene objects at a given frame.

Gets game-wide cache. Game-wide cache can be used to share data across scenes.

A cache is a map-like type that is used for game-wide and scene-wide user-data containers. The instances of this class are created and managed by the game engine. Scene and game caches can be used to exchange and store user-defined data between frames of the same scene or between scenes of the game. Note that by default these caches are in-memory only and not persistent between game executions. One could, however, add persistence using one of the lifecycle methods available through CPLifecycle type that is extended by both CPSceneObject and CPScene types.

Gets log instance.

Gets scene-wide cache. Scene-wide cache gets cleared when scene changes.

A cache is a map-like type that is used for game-wide and scene-wide user-data containers. The instances of this class are created and managed by the game engine. Scene and game caches can be used to exchange and store user-defined data between frames of the same scene or between scenes of the game. Note that by default these caches are in-memory only and not persistent between game executions. One could, however, add persistence using one of the lifecycle methods available through CPLifecycle type that is extended by both CPSceneObject and CPScene types.

Gets frame count since the beginning of the current scene.

Gets the timestamp in milliseconds of the game start.

Gets the timestamp in milliseconds of the current scene start.