Public Member Functions |
| Script (Context *context) |
| Construct.
|
| ~Script () |
| Destruct. Release the AngelScript engine.
|
bool | Execute (const String &line) |
| Compile and execute a line of script in immediate mode.
|
void | SetDefaultScriptFile (ScriptFile *file) |
| Set immediate mode script file.
|
void | SetDefaultScene (Scene *scene) |
| Set immediate mode scene.
|
void | SetLogMode (ScriptLogMode mode) |
| Set script engine logging mode, immediate is default.
|
void | ClearLogMessages () |
| Clear retained mode log messages.
|
void | DumpAPI () |
| Print the whole script API (all registered classes, methods and properties) to the log. No-ops when ENABLE_LOGGING not defined.
|
void | MessageCallback (const asSMessageInfo *msg) |
| Log a message from the script engine.
|
void | ExceptionCallback (asIScriptContext *context) |
| Handle a script exception.
|
asIScriptEngine * | GetScriptEngine () const |
| Return the AngelScript engine.
|
asIScriptContext * | GetImmediateContext () const |
| Return immediate execution script context.
|
ScriptFile * | GetDefaultScriptFile () const |
| Return immediate mode script file.
|
Scene * | GetDefaultScene () const |
| Return immediate mode scene.
|
void | ClearObjectTypeCache () |
| Clear the inbuild object type cache.
|
asIObjectType * | GetObjectType (const char *declaration) |
| Query for an inbuilt object type by constant declaration. Can not be used for script types.
|
ScriptLogMode | GetLogMode () const |
| Return logging mode.
|
const String & | GetLogMessages () const |
| Return retained mode log messages.
|
| Object (Context *context) |
| Construct.
|
virtual | ~Object () |
| Destruct. Clean up self from event sender & receiver structures.
|
virtual ShortStringHash | GetType () const =0 |
| Return type hash.
|
virtual const String & | GetTypeName () const =0 |
| Return type name.
|
virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| Handle event.
|
void | SubscribeToEvent (StringHash eventType, EventHandler *handler) |
| Subscribe to an event that can be sent by any sender.
|
void | SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler) |
| Subscribe to a specific sender's event.
|
void | UnsubscribeFromEvent (StringHash eventType) |
| Unsubscribe from an event.
|
void | UnsubscribeFromEvent (Object *sender, StringHash eventType) |
| Unsubscribe from a specific sender's event.
|
void | UnsubscribeFromEvents (Object *sender) |
| Unsubscribe from a specific sender's events.
|
void | UnsubscribeFromAllEvents () |
| Unsubscribe from all events.
|
void | UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData) |
| Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
|
void | SendEvent (StringHash eventType) |
| Send event to all subscribers.
|
void | SendEvent (StringHash eventType, VariantMap &eventData) |
| Send event with parameters to all subscribers.
|
Context * | GetContext () const |
| Return execution context.
|
Object * | GetSubsystem (ShortStringHash type) const |
| Return subsystem by type.
|
Object * | GetEventSender () const |
| Return active event sender. Null outside event handling.
|
EventHandler * | GetEventHandler () const |
| Return active event handler. Null outside event handling.
|
bool | HasSubscribedToEvent (StringHash eventType) const |
| Return whether has subscribed to an event without specific sender.
|
bool | HasSubscribedToEvent (Object *sender, StringHash eventType) const |
| Return whether has subscribed to a specific sender's event.
|
template<class T > |
T * | GetSubsystem () const |
| Template version of returning a subsystem.
|
| RefCounted () |
| Construct. Allocate the reference count structure and set an initial self weak reference.
|
virtual | ~RefCounted () |
| Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
|
void | AddRef () |
| Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
|
void | ReleaseRef () |
| Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
|
int | Refs () const |
| Return reference count.
|
int | WeakRefs () const |
| Return weak reference count.
|
RefCount * | RefCountPtr () |
| Return pointer to the reference count structure.
|
Scripting subsystem. Allows execution of AngelScript.