Skip to content

Commit

Permalink
Document Ticker plugin, still learning rst
Browse files Browse the repository at this point in the history
  • Loading branch information
nickelpro committed Oct 1, 2015
1 parent 0c8607c commit 75a69cf
Showing 1 changed file with 29 additions and 4 deletions.
33 changes: 29 additions & 4 deletions docs/plugins/core/ticker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,34 @@ Description

Events
======
Undocumented
.. object:: action_tick

Methods and Attributes
======================
Undocumented
This tick is for scheduling physical actions for the client, specifically
those related to movement. Any plugin that wishes to move the client
should schedule those movements by hooking into `action_tick` and calling
the appropriate pathfinding or movement methods.

**Playload** ::

None

.. object:: physics_tick

This tick fires immediately after `action_tick` and signals that all
movement actions have been scheduled and the client is ready to process
the movement actions as well as world forces to resolve a position for
the client. The default PhysicsPlugin depends on this event.

**Playload** ::

None

.. object:: client_tick

This tick fires immediately after `physics_tick` and signals that a new
position has been resolved for the client and is ready to be sent to the
server. The default MovementPlugin depends on this event.

**Playload** ::

None

0 comments on commit 75a69cf

Please sign in to comment.