/* * ============================================================ * FILE: player.c * * PURPOSE: The heart of the current milestone: how the character runs, * turns and jumps. Modeled on SM64's approach: an explicit state * machine, speed that follows the analog stick, and a facing * direction that turns toward the stick instead of snapping. * * FITS IN: Implements player.h. Reads Input (controls.h). Writes the * Body's velocity, then calls physics_step() (physics.h) to do the * actual motion. Tunables all come from config.h. * * IMPLEMENT: * - player_init / player_reset: body.pos = spawn, vel = 0, on_ground = true, * body.half_width = PLAYER_HALF_WIDTH, body.height = PLAYER_HEIGHT, * facing_yaw = 0, forward_speed = 0, state = PLAYER_IDLE, * heightened_movement = false, heightened_timer = 0, * retreating_movement = false, jump_kind = JUMP_NONE, skid_time = 0, * skid_speed = 0, skid_yaw = 0. * * - player_update(p, in, camera_yaw, dt). Use one static helper per state * (update_ground for IDLE + RUN / update_skid / update_jump / update_fall), dispatched by a * `switch (p->state)`. Keep each helper short. Shared steps: * * A. Stick -> world direction (camera-relative). Using camera.h's convention: * fwd = (-sin(camera_yaw), 0, -cos(camera_yaw)) * right = ( cos(camera_yaw), 0, -sin(camera_yaw)) * wish = fwd * in->move.y + right * in->move.x * mag = vec2_length(in->move) (0..1, already deadzoned) * wish_yaw = atan2f(wish.x, wish.z) (only meaningful if mag > 0) * * B. Ground movement (IDLE / RUN): * - If mag > 0, forward_speed == 0 and wish_yaw is more than * PLAYER_SNAP_TURN_DEG away from facing_yaw: facing_yaw = wish_yaw * at once (standing still, a big turn happens on a dime). Smaller * turns still use the quick turn rate below, so small stick * adjustments stay smooth instead of twitching. * - If mag > 0: facing_yaw = approach_angle(facing_yaw, wish_yaw, * PLAYER_TURN_RATE * dt); forward_speed = approachf(forward_speed, * PLAYER_MAX_SPEED * mag, PLAYER_GROUND_ACCEL * dt) * - Faster than PLAYER_MAX_SPEED with the stick pushed (landing from a * normal jump at up to PLAYER_JUMP_MAX_SPEED): ease back down to * PLAYER_MAX_SPEED at PLAYER_OVERSPEED_DECEL instead, so the extra * speed fades over ~0.5 s rather than vanishing on landing. * (Releasing the stick still uses the normal friction.) * - Else: forward_speed = approachf(forward_speed, 0, * PLAYER_GROUND_FRICTION * dt). Accel and friction are low on * purpose: starts build up and stops skid briefly, so the player * feels like a heavy, real object rather than a cursor. * - State: forward_speed > 0 -> RUN, otherwise IDLE. * - Pulling back at full run -> SKID (see B2), checked before steering. * * B2. Skid (SM64's turnaround skid). In IDLE/RUN, if mag > 0, * forward_speed >= PLAYER_MAX_SPEED * PLAYER_SKID_SPEED_FRACTION ("full * run and above", so faster future moves count too), and wish_yaw is * more than PLAYER_SKID_ANGLE_DEG from facing_yaw: state = SKID, * retreating_movement = true, skid_yaw = facing_yaw (the slide keeps * going the old way), skid_speed = forward_speed, skid_time = 0. * While skidding: * - The player FACES THE STICK at once (and keeps tracking it), while * still sliding along skid_yaw: turned around, sliding backward. * - No steering. Speed follows a curve, whatever the stick does: * forward_speed = skid_speed * (1 - (skid_time / PLAYER_SKID_DURATION) * ^ PLAYER_SKID_GLIDE_POWER) * Braking starts near zero, so it glides like a short slide, then * builds so the player stops exactly at PLAYER_SKID_DURATION. * - At PLAYER_SKID_DURATION: speed 0, retreating_movement off, IDLE. * - Sliding off an edge ends the skid too (facing_yaw goes back to * skid_yaw, so the fall keeps the slide's direction). * WHY: at full run a U-turn used to keep all its speed; the skid * makes reversing a committed, weighty slide. * * C. Jump (from IDLE / RUN / SKID): if in->jump_pressed and body.on_ground: * on_ground = false; state = JUMP, and then one of * - in SKID: the RETREAT jump, like SM64's side flip. The player * already faces the stick (or where it last pointed), forward_speed = * PLAYER_RETREAT_JUMP_SPEED, body.vel.y = PLAYER_RETREAT_JUMP_VELOCITY * (2x the height, the highest jump); jump_kind = JUMP_RETREAT. * retreating_movement stays on until it lands. * - heightened_movement on: the SECOND jump, SM64's double jump. * body.vel.y = PLAYER_SECOND_JUMP_VELOCITY (1.75x the height); * jump_kind = JUMP_SECOND. heightened_movement stays on for the * whole jump, however long it lasts. * - otherwise a normal jump: body.vel.y = PLAYER_JUMP_VELOCITY; * jump_kind = JUMP_NORMAL. * * C2. Landing: landing from a normal jump (JUMP_NORMAL, short hop or * full) or a retreat jump (JUMP_RETREAT) turns heightened_movement on * with heightened_timer = PLAYER_SECOND_JUMP_WINDOW, so either one * can lead into the second jump. Landing any other way (from the * second jump, or after walking off an edge) turns it off. Every * landing turns retreating_movement off and resets jump_kind to * JUMP_NONE. Every tick, unless the player is in the second jump, the * heightened timer counts down and it turns off at 0. WHY named * states rather than private "can double jump" flags: later moves * will key off them too. * * D. Air movement (JUMP / FALL): the same as B, but the turn rate is * multiplied by PLAYER_AIR_CONTROL, accel is PLAYER_AIR_ACCEL, there's * no instant turn from a standstill, and there's NO friction when the * stick is released (you keep your momentum, like SM64). * - Top speed: steering aims for top_speed() * mag, where top_speed() * is PLAYER_JUMP_MAX_SPEED in a normal jump, * PLAYER_SECOND_JUMP_MAX_SPEED in the second jump, * PLAYER_RETREAT_JUMP_SPEED in the retreat jump, and * PLAYER_MAX_SPEED otherwise. * - Building past run speed: up to PLAYER_MAX_SPEED * mag the air * accelerates at PLAYER_AIR_ACCEL as usual; beyond it (only a * normal jump allows that) only at PLAYER_JUMP_BOOST_ACCEL. So a full * jump taken at a full run gains ~1 m/s by landing: a small, * gradual reward for jumping, not a burst. While forward_speed is ABOVE it (a * full run into the second jump), the stick only turns: the extra * speed bleeds off at PLAYER_SECOND_JUMP_SLOWDOWN, whatever the * stick does. So a 6 m/s run into the second jump eases down to * 5 m/s over ~0.3 s. WHY a separate, gentle rate: slowing at * PLAYER_AIR_ACCEL (~0.25 s) felt like hitting a wall of syrup * right at takeoff. 6 m/s only comes back (through normal ground * accel) after landing. WHY no new state: jump_kind already says * which jump the player is in. * - Variable jump height (every jump): in JUMP, if !in->jump_held and vel.y > 0, * multiply vel.y by PLAYER_JUMP_CUT ONCE (don't repeat it every tick; * either switch to FALL right away or keep a flag). Comment WHY: tapping A * gives a hop, holding it gives a full jump. * - JUMP -> FALL when vel.y <= 0. * - FALL -> IDLE/RUN when body.on_ground (landing; apply C2 first, so * an A press on the landing tick already gets the second jump). * - If the player is on the ground state-wise but body.on_ground is false * (walked off a platform edge) -> FALL. * * E. Apply: move_yaw = skid_yaw while in SKID, else facing_yaw. * body.vel.x = sin(move_yaw) * forward_speed * body.vel.z = cos(move_yaw) * forward_speed * then physics_step(&p->body, dt). * * - player_state_name: a switch that returns string literals. * * CONVENTIONS: Facing vector = (sin(yaw), 0, cos(yaw)). Speeds are in m/s, * accelerations in m/s^2, and every one of them multiplies by dt. * No magic numbers; everything comes from config.h. * * NOT IN SCOPE: Triple jump, long jump, wall kick, ground pound, skids * below full run speed, slopes, coyote time, jump buffering. * Leave a short comment at the state enum pointing to the * README roadmap as the place to grow. * * DONE WHEN: Small stick tilts walk slowly and full tilt runs at * PLAYER_MAX_SPEED after a noticeable build-up. Turning is quick but * not instant while moving, and instant for big turns from a standstill. Letting go * of the stick skids the player to a short, smooth stop. A tap of A * gives a short hop and holding A gives a full ~2.4 m jump. Pressing * A within 0.2 s of landing gives a second jump 1.75x as high, with * heightened_movement on from that landing until the second jump * lands. Pulling the stick back at full run turns the player to * face the stick and slides them backward to a stop over 0.5 s, * and A during that slide launches a 2x-height jump toward the * stick at 4 m/s; landing it opens the second-jump window too. A * full jump at full run builds gently to ~7 m/s, and that extra * speed eases back to 6 m/s after landing. The player lands cleanly back in IDLE/RUN. * ============================================================ */ #include "config.h" #include "player.h" /* What the stick is asking for this tick, in world space. */ typedef struct { float mag; /* 0..1, how far the stick is pushed */ float yaw; /* world direction to move in; only meaningful if mag > 0 */ } Wish; static void update_ground(Player *p, const Input *in, Wish wish, float dt); static void update_skid(Player *p, const Input *in, Wish wish, float dt); static void update_fall(Player *p, const Input *in, Wish wish, float dt); /* A. Stick -> world direction. "Up" on the stick means "away from the * camera", so the stick is rotated by the camera's yaw (camera.h's * convention for forward/right on the ground plane). */ static Wish compute_wish(const Input *in, float camera_yaw) { Vec3 fwd = vec3_make(-sinf(camera_yaw), 0.0f, -cosf(camera_yaw)); Vec3 right = vec3_make( cosf(camera_yaw), 0.0f, -sinf(camera_yaw)); Vec3 dir = vec3_add(vec3_scale(fwd, in->move.y), vec3_scale(right, in->move.x)); Wish wish; wish.mag = vec2_length(in->move); wish.yaw = atan2f(dir.x, dir.z); /* inverse of facing = (sin(yaw), 0, cos(yaw)) */ return wish; } /* The fastest the player may go right now. The second and retreat jumps * trade horizontal speed for their extra height, until they land. */ static float top_speed(const Player *p) { switch (p->jump_kind) { case JUMP_NORMAL: return PLAYER_JUMP_MAX_SPEED; case JUMP_SECOND: return PLAYER_SECOND_JUMP_MAX_SPEED; case JUMP_RETREAT: return PLAYER_RETREAT_JUMP_SPEED; default: return PLAYER_MAX_SPEED; } } /* Degrees to radians, for the _DEG tunables. */ static float deg_to_rad(float deg) { return deg * (M3D_PI / 180.0f); } /* How far the stick points from where the player faces, 0..PI radians. */ static float angle_off_facing(const Player *p, Wish wish) { return fabsf(wrap_angle(wish.yaw - p->facing_yaw)); } /* Turns the facing toward the stick, at most turn_rate. */ static void turn(Player *p, Wish wish, float turn_rate, float dt) { p->facing_yaw = approach_angle(p->facing_yaw, wish.yaw, turn_rate * dt); } /* Turns toward the stick and changes speed toward target_speed by at most * `rate`. Shared by ground and air movement; the air passes smaller rates. */ static void steer(Player *p, Wish wish, float turn_rate, float target_speed, float rate, float dt) { turn(p, wish, turn_rate, dt); p->forward_speed = approachf(p->forward_speed, target_speed, rate * dt); } /* Standing still vs walking vs running is only a matter of speed. */ static PlayerState grounded_state(const Player *p) { return p->forward_speed > 0.0f ? PLAYER_RUN : PLAYER_IDLE; } /* C. Leaves the ground with the given upward speed. */ static void leave_ground(Player *p, float vel_y, JumpKind kind) { p->body.vel.y = vel_y; p->body.on_ground = false; p->jump_kind = kind; p->state = PLAYER_JUMP; } /* C. A jump from IDLE/RUN. While heightened_movement is on (just after * landing a normal jump), A gives the higher second jump instead, like * SM64's double jump. heightened_movement stays on through the whole * second jump. */ static void start_jump(Player *p) { if (p->heightened_movement) leave_ground(p, PLAYER_SECOND_JUMP_VELOCITY, JUMP_SECOND); else leave_ground(p, PLAYER_JUMP_VELOCITY, JUMP_NORMAL); } /* C. The jump out of a skid, like SM64's side flip: the player already faces * where the stick points (the skid turned them) and launches that way, * higher than any other jump but slower. retreating_movement stays on * until it lands. */ static void start_retreat_jump(Player *p) { p->forward_speed = PLAYER_RETREAT_JUMP_SPEED; leave_ground(p, PLAYER_RETREAT_JUMP_VELOCITY, JUMP_RETREAT); } /* C2. Touching down. Landing a normal jump (a hop or a full one) or a * retreat jump opens the short window for the second jump; landing any * other way closes it, so the second jump can't chain into another one. * Any landing ends a retreat jump's retreating_movement. */ static void land(Player *p) { if (p->jump_kind == JUMP_NORMAL || p->jump_kind == JUMP_RETREAT) { p->heightened_movement = true; p->heightened_timer = PLAYER_SECOND_JUMP_WINDOW; } else { p->heightened_movement = false; } p->retreating_movement = false; p->jump_kind = JUMP_NONE; } /* C2. The window after landing runs out on its own. It doesn't during the * second jump: heightened_movement lasts as long as that jump does. */ static void count_down_heightened(Player *p, float dt) { if (!p->heightened_movement || p->jump_kind == JUMP_SECOND) return; p->heightened_timer -= dt; if (p->heightened_timer <= 0.0f) p->heightened_movement = false; } /* B2. Pulling the stick back while running flat out. "Full run and above", * so the faster moves still to come can skid too. */ static bool wants_skid(const Player *p, Wish wish) { return wish.mag > 0.0f && p->forward_speed >= PLAYER_MAX_SPEED * PLAYER_SKID_SPEED_FRACTION && angle_off_facing(p, wish) > deg_to_rad(PLAYER_SKID_ANGLE_DEG); } /* B + C. IDLE and RUN: full control, friction when the stick is released, * and where normal jumps start. */ static void update_ground(Player *p, const Input *in, Wish wish, float dt) { /* Walked off a platform edge: start falling. */ if (!p->body.on_ground) { p->state = PLAYER_FALL; update_fall(p, in, wish, dt); return; } if (wants_skid(p, wish)) { p->state = PLAYER_SKID; p->retreating_movement = true; p->skid_yaw = p->facing_yaw; /* keep sliding the way we were running */ p->skid_speed = p->forward_speed; p->skid_time = 0.0f; update_skid(p, in, wish, dt); return; } if (wish.mag > 0.0f) { /* Standing still there's no momentum to swing around, so a big turn * faces the stick right away. Small ones keep the quick turn rate so * nudging the stick to adjust your aim still looks smooth. */ if (p->forward_speed == 0.0f && angle_off_facing(p, wish) > deg_to_rad(PLAYER_SNAP_TURN_DEG)) p->facing_yaw = wish.yaw; /* Landed from a normal jump carrying more than run speed: let the * extra fade slowly instead of vanishing the moment we touch down. */ if (p->forward_speed > top_speed(p)) steer(p, wish, PLAYER_TURN_RATE, top_speed(p), PLAYER_OVERSPEED_DECEL, dt); else steer(p, wish, PLAYER_TURN_RATE, top_speed(p) * wish.mag, PLAYER_GROUND_ACCEL, dt); } else { p->forward_speed = approachf(p->forward_speed, 0.0f, PLAYER_GROUND_FRICTION * dt); } p->state = grounded_state(p); if (in->jump_pressed) start_jump(p); } /* B2 + C. SKID: pulled back at full run. The player turns to face the stick * right away but keeps sliding the old way (skid_yaw), like a short * slide on the heels. retreating_movement is on the whole time, and A * launches the retreat jump. */ static void update_skid(Player *p, const Input *in, Wish wish, float dt) { /* Slid off a platform edge: the skid (and its jump) is over. The air * moves along facing_yaw, so point it back along the slide to keep the * player's momentum going the same way. */ if (!p->body.on_ground) { p->retreating_movement = false; p->facing_yaw = p->skid_yaw; p->state = PLAYER_FALL; update_fall(p, in, wish, dt); return; } /* Face the stick immediately; the slide direction doesn't change. */ if (wish.mag > 0.0f) p->facing_yaw = wish.yaw; if (in->jump_pressed) { start_retreat_jump(p); return; } /* Glide, then plant: braking starts near zero and builds, so the first * part feels like a free slide and the player stops exactly when the skid * ends. PLAYER_SKID_GLIDE_POWER shapes the curve (1 = even braking). */ p->skid_time += dt; float t = clampf(p->skid_time / PLAYER_SKID_DURATION, 0.0f, 1.0f); p->forward_speed = p->skid_speed * (1.0f - powf(t, PLAYER_SKID_GLIDE_POWER)); if (t >= 1.0f) { p->forward_speed = 0.0f; p->retreating_movement = false; p->state = PLAYER_IDLE; } } /* D. Air movement: weaker steering, and NO friction when the stick is * released, so you keep your momentum like in SM64. */ static void air_steer(Player *p, Wish wish, float dt) { float air_turn_rate = PLAYER_TURN_RATE * PLAYER_AIR_CONTROL; /* Faster than the top speed allows (a full run into the second jump): * shed the extra slowly, whatever the stick says, so takeoff doesn't feel * like hitting a wall. The stick can still turn. */ if (p->forward_speed > top_speed(p)) { if (wish.mag > 0.0f) turn(p, wish, air_turn_rate, dt); p->forward_speed = approachf(p->forward_speed, top_speed(p), PLAYER_SECOND_JUMP_SLOWDOWN * dt); return; } if (wish.mag <= 0.0f) return; /* Up to what running would give, the air accelerates as usual. Past it * (only a normal jump's top speed allows that) speed builds slowly: a * small reward for jumping at full run, not a burst. */ float target = top_speed(p) * wish.mag; float run_target = fminf(target, PLAYER_MAX_SPEED * wish.mag); if (target > run_target && p->forward_speed >= run_target) steer(p, wish, air_turn_rate, target, PLAYER_JUMP_BOOST_ACCEL, dt); else steer(p, wish, air_turn_rate, run_target, PLAYER_AIR_ACCEL, dt); } /* FALL: in the air, going down. Landing hands straight over to the ground * logic on the same tick, so a jump pressed on the landing tick isn't lost * (and already counts as the second jump). */ static void update_fall(Player *p, const Input *in, Wish wish, float dt) { if (p->body.on_ground) { land(p); p->state = grounded_state(p); update_ground(p, in, wish, dt); return; } air_steer(p, wish, dt); } /* JUMP: in the air, still rising from a jump. */ static void update_jump(Player *p, const Input *in, Wish wish, float dt) { /* Past the apex (or landed already): it's a fall now. */ if (p->body.vel.y <= 0.0f) { p->state = PLAYER_FALL; update_fall(p, in, wish, dt); return; } air_steer(p, wish, dt); /* Variable jump height: letting go of A while rising cuts the upward speed. * Tapping A gives a short hop, holding it gives the full jump (for the * second and retreat jumps too). Switching to * FALL right away makes sure the cut happens only once. */ if (!in->jump_held) { p->body.vel.y *= PLAYER_JUMP_CUT; p->state = PLAYER_FALL; } } void player_init(Player *p, Vec3 spawn) { p->body.pos = spawn; p->body.vel = vec3_make(0.0f, 0.0f, 0.0f); p->body.on_ground = true; p->body.half_width = PLAYER_HALF_WIDTH; /* the collision box matches the drawn box */ p->body.height = PLAYER_HEIGHT; p->facing_yaw = 0.0f; p->forward_speed = 0.0f; p->state = PLAYER_IDLE; p->heightened_movement = false; p->heightened_timer = 0.0f; p->retreating_movement = false; p->jump_kind = JUMP_NONE; p->skid_time = 0.0f; p->skid_speed = 0.0f; p->skid_yaw = 0.0f; } void player_reset(Player *p, Vec3 spawn) { player_init(p, spawn); } void player_update(Player *p, const Input *in, float camera_yaw, float dt) { Wish wish = compute_wish(in, camera_yaw); count_down_heightened(p, dt); /* IDLE and RUN share one helper: they differ only in speed. */ switch (p->state) { case PLAYER_IDLE: case PLAYER_RUN: update_ground(p, in, wish, dt); break; case PLAYER_SKID: update_skid(p, in, wish, dt); break; case PLAYER_JUMP: update_jump(p, in, wish, dt); break; case PLAYER_FALL: update_fall(p, in, wish, dt); break; } /* E. Turn speed into a velocity, then let physics move us. The player * moves where they face, except in a skid: they've already turned to * the stick but keep sliding the way they were running. */ float move_yaw = p->state == PLAYER_SKID ? p->skid_yaw : p->facing_yaw; p->body.vel.x = sinf(move_yaw) * p->forward_speed; p->body.vel.z = cosf(move_yaw) * p->forward_speed; physics_step(&p->body, dt); } const char *player_state_name(PlayerState s) { switch (s) { case PLAYER_IDLE: return "IDLE"; case PLAYER_RUN: return "RUN"; case PLAYER_JUMP: return "JUMP"; case PLAYER_FALL: return "FALL"; case PLAYER_SKID: return "SKID"; } return "?"; }