summaryrefslogtreecommitdiff
path: root/platformer/src/player.h
blob: bedfaf443cc77c024a6dfd8028f30b455bca3b3a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
/*
 * ============================================================
 * FILE:        player.h
 *
 * PURPOSE:     Public interface for the player character: its state and the
 *              one function that advances it each tick.
 *
 * FITS IN:     main.c owns one Player, calls player_update() each tick, and
 *              calls player_reset() on Input.reset_pressed. render.c reads it
 *              to draw it.
 *
 * INTERFACE:   Use these exact names:
 *
 *   typedef enum PlayerState {
 *       PLAYER_IDLE,     on ground, not moving
 *       PLAYER_RUN,      on ground, moving (walk vs run is just speed)
 *       PLAYER_JUMP,     in air, going up after a jump
 *       PLAYER_FALL      in air, going down (or walked off something)
 *   } PlayerState;
 *
 *   typedef struct Player {
 *       Body        body;           position / velocity / on_ground (physics.h)
 *       float       facing_yaw;     direction the player faces, radians.
 *                                   Facing vector = (sin(yaw), 0, cos(yaw)),
 *                                   which matches mat4_rotate_y in math3d.h.
 *       float       forward_speed;  ground speed along facing_yaw, m/s (>= 0)
 *       PlayerState state;
 *   } Player;
 *
 *   void        player_init(Player *p, Vec3 spawn);
 *   void        player_reset(Player *p, Vec3 spawn);
 *   void        player_update(Player *p, const Input *in, float camera_yaw, float dt);
 *                   camera_yaw is a plain float so player.c doesn't depend on camera.h.
 *   const char *player_state_name(PlayerState s);   "IDLE", "RUN", ... for debug
 *
 *   Include "math3d.h", "physics.h", "controls.h".
 *
 * CONVENTIONS: Include guard: PLAYER_H.
 *
 * NOT IN SCOPE: Health, animation, extra moves (see README roadmap).
 *
 * DONE WHEN:   main.c and render.c compile against this header alone.
 * ============================================================
 */
#ifndef PLAYER_H
#define PLAYER_H

#endif /* PLAYER_H */