Module: Scheduler::EventTasks
- Defined in:
- docs/00700_Ajout_PSDK.rb
Overview
Module that aim to add task triggered by events actions
List of the event actions :
- begin_step
- begin_jump
-
- end_step
- end_jump
-
Events can be specified with the following criteria
- map_id / :any : ID of the map where the task can trigger
- event_id / :any : ID of the event that trigger the task (-1 = player, -2 its first follower, -3 its second, ...)
Parameter sent to the task :
- event : Game_Character object that triggered the task
- event_id : ID of the event that triggered the task (for :any tasks)
- map_id : ID of the map where the task was triggered (for :any tasks)
Important note : The system will detect the original id & map of the events (that’s why the event object is sent & its id)
Class Method Summary collapse
-
.delete(task_type, description, event_id, map_id)
Remove a task.
-
.on(task_type, description, event_id = :any, map_id = :any, &task)
Add a new task.
-
.resolve_id(event) ⇒ Integer
Resolve the id of the event.
-
.resolve_map_id(event) ⇒ Integer
Resolve the id of the event.
-
.trigger(task_type, event)
Trigger a specific task.
Class Method Details
.delete(task_type, description, event_id, map_id)
Remove a task
359 360 |
# File 'docs/00700_Ajout_PSDK.rb', line 359 def delete(task_type, description, event_id, map_id) end |
.on(task_type, description, event_id = :any, map_id = :any, &task)
Add a new task
337 338 |
# File 'docs/00700_Ajout_PSDK.rb', line 337 def on(task_type, description, event_id = :any, map_id = :any, &task) end |
.resolve_id(event) ⇒ Integer
Resolve the id of the event
347 348 |
# File 'docs/00700_Ajout_PSDK.rb', line 347 def resolve_id(event) end |
.resolve_map_id(event) ⇒ Integer
Resolve the id of the event
352 353 |
# File 'docs/00700_Ajout_PSDK.rb', line 352 def resolve_map_id(event) end |
.trigger(task_type, event)
Trigger a specific task
342 343 |
# File 'docs/00700_Ajout_PSDK.rb', line 342 def trigger(task_type, event) end |