Adonthell  0.4
action_event Class Reference

To notify when a mapcharacter "act" on a square. More...

#include <map_event.h>

Inheritance diagram for action_event:
Collaboration diagram for action_event:

Public Member Functions

 action_event ()
 Default constructor. More...
 
- Public Member Functions inherited from map_event
 map_event ()
 Default constructor. More...
 
void put_state (ogzstream &) const
 Saves the basic event data (such as the type or script data) to a file. More...
 
bool get_state (igzstream &)
 Loads the basic event date from a file. More...
 
bool equals (const event *evnt)
 Compare two map events for equality. More...
 
s_int32 execute (const event *evnt)
 Executes the script associated with this map event. More...
 
- Public Member Functions inherited from event
 event ()
 Constructor. More...
 
virtual ~event ()
 Destructor. More...
 
void clear ()
 Cleanup. More...
 
void set_script (string filename, PyObject *args=NULL)
 Sets a script to be executed whenever the event occurs. More...
 
void set_callback (PyObject *callback, PyObject *args=NULL)
 Sets a python function/method to be executed whenever the event occurs. More...
 
void set_callback (const Functor0 &callback)
 Sets a C function/C++ method to be executed whenever the event occurs. More...
 
u_int8 type () const
 Get the event's type. More...
 
const string & id () const
 Get the event's id. More...
 
void set_id (const string &id)
 Assign an id to the event, so it may be retrieved from an event_list later on, without having a pointer to it. More...
 
bool registered () const
 Test whether the event is registered with the event handler. More...
 
void set_registered (bool reg)
 Set whether the event is registered with the event handler. More...
 
void set_list (event_list *list)
 Tell the whether it is kept in an event_list. More...
 
s_int32 repeat () const
 Return whether this event should be repeated. More...
 
void set_repeat (s_int32 count)
 Set whether this event should be repeated. More...
 
virtual void pause ()
 Disable the event temporarily. More...
 
virtual void resume ()
 Re-enable an event that has been paused. More...
 
bool is_paused () const
 Check whether the event is temporarily disabled or not. More...
 

Additional Inherited Members

- Public Attributes inherited from map_event
s_int32 submap
 Submap index (-1 for any). More...
 
s_int32 x
 X position (-1 for any). More...
 
s_int32 y
 Y position (-1 for any). More...
 
s_int8 dir
 Direction where the character is looking (-1 for any). More...
 
s_int32 map
 Useless (for now). More...
 
mapcharacterc
 Pointer to the mapcharacter that can launch this event (NULL for any). More...
 
- Protected Member Functions inherited from event
s_int32 do_repeat ()
 Decrease the event's repeat count and return the number of repeats left. More...
 
- Protected Attributes inherited from event
u_int8 Type
 Event type - see enum above. More...
 
string Id
 (Optional) Id of the event More...
 
u_int8 Action
 What happens if the event occurs - see enum above. More...
 
bool Registered
 Whether the event is registered with the event handler. More...
 
bool Paused
 Whether the event temporarily disabled or not. More...
 
s_int32 Repeat
 Defines how often the event should be repeated. More...
 
py_objectScript
 The Python script accociated with this event. More...
 
PyObject * Args
 The arguments passed to the script. More...
 
py_callbackPyFunc
 Python callback that may be executed instead of the script. More...
 
Functor0 Callback
 C++ callback that may be executed when the event gets triggered. More...
 
event_listList
 The event_list this event is kept in. More...
 

Detailed Description

To notify when a mapcharacter "act" on a square.

Definition at line 139 of file map_event.h.

Constructor & Destructor Documentation

§ action_event()

action_event::action_event ( )

Default constructor.

Definition at line 141 of file map_event.cc.


The documentation for this class was generated from the following files: