mm/include/z64rumble.h
Derek Hensley 3705eaedac
Small general cleanup (#1644)
* m2ctx.py

* check warnings

* vimode includes

* bgcheck includes

* padmgr includes

* sprintf

* z_std_dma

* sys_ucode

* z64voice

* z64lib

* z64effect_ss

* segment_symbols.h

* padutils

* main

* stdarg.h

* fault

* bzero

* undefined_syms

* z64rumble
2024-06-14 21:47:24 -07:00

46 lines
2.7 KiB
C

#ifndef Z64RUMBLE_H
#define Z64RUMBLE_H
#include "PR/ultratypes.h"
typedef enum RumbleManagerState {
/* 0 */ RUMBLEMANAGER_STATE_WIPE, // Disables the request processing and wipes every request. It can be either set manually or automatically by the system as fail-safe in case the Rumble Pak has been vibrating for 2 minutes
/* 1 */ RUMBLEMANAGER_STATE_RUNNING, // Normal execution and updating
/* 2 */ RUMBLEMANAGER_STATE_INITIAL // Indicates initialization and cleanup must be done before processing the rumble requests. All the old requests on are wiped on this state. Then it proceeds to RUMBLEMANAGER_STATE_RUNNING
} RumbleManagerState;
#define RUMBLE_REQUEST_BUFFER_SIZE 0x40
typedef struct RumbleManager {
/* 0x000 */ u8 rumbleEnabled[MAXCONTROLLERS];
/* 0x004 */ u8 requestIntensities[RUMBLE_REQUEST_BUFFER_SIZE]; // seems to have two purposes: act as a priority value over the other rumble requests and to contribute to requestAccumulators on each tick
/* 0x044 */ u8 requestDecayTimers[RUMBLE_REQUEST_BUFFER_SIZE]; // amount of ticks this request will run before requestIntensities starts decreasing
/* 0x084 */ u8 requestDecaySteps[RUMBLE_REQUEST_BUFFER_SIZE]; // used to decrease requestIntensities by this amount each tick after requestDecayTimers runs out
/* 0x0C4 */ u8 requestAccumulators[RUMBLE_REQUEST_BUFFER_SIZE]; // the value contained here plus requestIntensities must meet a certain threshold to start rumbling this tick
/* 0x104 */ u8 state;
/* 0x105 */ u8 updateEnabled; // boolean value which controls if the Update function should be run. Unlike RUMBLEMANAGER_STATE_WIPE, disabling this does not wipe the state of the requests
/* 0x106 */ u16 rumblingDuration; // amount of "ticks" updates the Rumble Pak has been rumbling without pause. It is restarted after 5 ticks of not rumbling
/* 0x108 */ u16 downTime; // small counter/timer used to restart rumblingDuration
/* 0x10A */ u8 overrideIntensity; // "override" counterpart for requestIntensities
/* 0x10B */ u8 overrideDecayTimer;
/* 0x10C */ u8 overrideDecayStep;
/* 0x10D */ u8 overrideAccumulator;
} RumbleManager; // size = 0x10E
extern RumbleManager gRumbleMgr;
void Rumble_Override(f32 distSq, u8 sourceIntensity, u8 decayTimer, u8 decayStep);
void Rumble_Request(f32 distSq, u8 sourceIntensity, u8 decayTimer, u8 decayStep);
void Rumble_Init(void);
void Rumble_Destroy(void);
s32 Rumble_ControllerOneHasRumblePak(void);
void Rumble_StateReset(void);
void Rumble_StateWipeRequests(void);
void Rumble_SetUpdateEnabled(s32 updateEnabled);
void RumbleManager_Update(RumbleManager* rumbleMgr);
void RumbleManager_Init(RumbleManager* rumbleMgr);
void RumbleManager_Destroy(RumbleManager* rumbleMgr);
#endif