tph/Repixture
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor and document follow_path_climb

Browse Source
This commit is contained in:
Wuzzy 2024-04-07 11:26:45 +02:00
parent 3ce7fd60f1
commit 2c902fb862
3 changed files with 29 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
mods/rp_mobs/API_TEMPLATES.md
View File

@ -136,10 +136,12 @@ Instantly set mob acceleration to the given `acceleration` parameter (a vector).
Finish condition: Finishes instantly.
### `rp_mobs.microtasks.follow_path(path, walk_speed, jump_strength, set_yaw, can_jump, stop_func)
### `rp_mobs.microtasks.follow_path(path, walk_speed, jump_strength, set_yaw, can_jump, finish_func)
Make the mob follow along a path, i.e. a sequence of positions by walking.
This assumes the mob is bound to gravity. Jumping and falling is supported.
This assumes the mob is bound to gravity along the whole path and the *entire* path is walkable.
Jumping and falling is supported, but not climbing or swimming.
Note: This function does not check the nodes along the path for validity.
Parameters:
@ -163,3 +165,25 @@ Finish condition: There are multiple reasons for finishing:
* When mob was stuck and unable to continue to walk for a few seconds (considered failure)
* When `finish_func` is has returned `true` for its 1st return value
### `rp_mobs.microtasks.follow_path_climb(path, walk_speed, climb_speed, set_yaw, finish_func, anim_walk, anim_climb, anim_idle)`
Make the mob follow along a path, i.e. a sequence of positions by *climbing*.
The difference from `rp_mobs.microtask.follow_path` is that the mob climbs instead
of walks. The path must exclusively consist of nodes that are considered 'climbable'.
This assumes the mob is *not* bound to gravity while climbing and the *entire* path consists of
climbable (or equivalent) nodes from the viewpoint of the mob.
This function could also be used to follow a path through nodes with liquid physics.
Parameters:
* `path`: See `rp_mobs.microtasks.follow_path`
* `walk_speed`: Horizontal movement speed
* `climb_speed`: Vertical movement speed
* `set_yaw`: See `rp_mobs.microtasks.follow_path`
* `finish_func`: See `rp_mobs.microtasks.follow_path`
* `anim_walk`: Mob animation name for horizontal movement (default: `"walk"`)
* `anim_climb`: Mob animation name for vertical movement (default: `"idle"`)
* `anim_idle`: Mob animation name when idling (default: `"idle"`)

4
mods/rp_mobs/task_templates.lua
View File

@ -86,7 +86,7 @@ end
rp_mobs.microtasks = {}
rp_mobs.microtasks.follow_path_climb = function(path, walk_speed, climb_speed, set_yaw, anim_idle, anim_walk, finish_func)
rp_mobs.microtasks.follow_path_climb = function(path, walk_speed, climb_speed, set_yaw, finish_func, anim_walk, anim_climb, anim_idle)
local mtask = {}
mtask.label = "follow climb path"
mtask.on_start = function(self, mob)
@ -210,7 +210,7 @@ rp_mobs.microtasks.follow_path_climb = function(path, walk_speed, climb_speed, s
vel.z = 0
mob.object:set_velocity(vel)
self.statedata.walking = false
rp_mobs.set_animation(mob, anim_idle or "idle")
rp_mobs.set_animation(mob, anim_climb or "idle")
end
end
mtask.is_finished = function(self, mob)

2
mods/rp_mobs_mobs/mobs/villager.lua
View File

@ -939,7 +939,7 @@ local path_to_microtasks = function(path)
mt = create_microtask_open_door(entry.pos, entry.axis)
mt.start_animation = "idle"
elseif entry.type == "climb" then
mt = rp_mobs.microtasks.follow_path_climb(entry.path, WALK_SPEED, CLIMB_SPEED, true, nil, nil, stop_follow_path_climb)
mt = rp_mobs.microtasks.follow_path_climb(entry.path, WALK_SPEED, CLIMB_SPEED, true, stop_follow_path_climb)
else
minetest.log("error", "[rp_mobs_mobs] path_to_microtasks: Invalid entry type in TODO list!")
return