Add documentation for unit->walktobl_timer

1 files changed, 9 insertions, 0 deletions

diff --git a/src/map/unit.c b/src/map/unit.c
index 644fd47bb..3c86ff02d 100644
--- a/src/map/unit.c
+++ b/src/map/unit.c
@@ -615,6 +615,15 @@ static inline void set_mobstate(struct block_list *bl, int flag)
 	}
 }
 
+/**
+ * Timer used for when a unit can't walk towards its target yet due to it's canmove_tick,
+ * keeps retrying until it works or target changes.
+ * @param tid: Timer ID, unused
+ * @param tick: Tick, unused
+ * @param id: ID of block_list to execute the action
+ * @param data: ID of block_list to walk towards
+ * @return 0: success, 1: failure
+ */
 static int unit_walktobl_timer(int tid, int64 tick, int id, intptr_t data)
 {
 	struct block_list *bl = map->id2bl(id);