pokeplatinum/include/scrcmd_sound.h
Eduardo Quezada ecb0f0c119
Some checks are pending
build / build (push) Waiting to run
Almost finished documenting ScrCmd for sound (#486)
* ScrCmd_IsSequencePlaying

* ScrCmd_SetSpecialBGM

* `sub_02055554` -> `Sound_TryFadeOutToBGM`

also `sub_020555CC` -> `Sound_GetBGMFadeOutAndWaitFrames`

* ScrCmd_FadeInBGM

* FadeOutMusic -> FadeOutBGM for consistency

* ScrCmd_SetBGMPlayerPaused

* ScrCmd_SetBGMFixed

* Constant uses

* ScrCmd_CheckRecordedChatotCryIsPlayable

* ScrCmd_TryRecordChatotCry

* ScrCmd_StopRecordingChatotCry

* ScrCmd_StopFanfare

* sdatID -> seqID

* ScrCmd_StoreRecordedChatotCry

* ScrCmd_SetSubScene63

* ScrCmd_SetInitialVolumeForSequence

* ScrCmd_SetScene22

* ScrCmd_SetFieldScene, ScrCmd_GetCurrentBGM

* ScrCmd_057 seqID

* Rename file

* Format
2025-04-24 03:51:56 -07:00

34 lines
1.3 KiB
C

#ifndef POKEPLATINUM_SCRCMD_SOUND_H
#define POKEPLATINUM_SCRCMD_SOUND_H
#include "field_script_context.h"
BOOL ScrCmd_IsSequencePlaying(ScriptContext *ctx);
BOOL ScrCmd_PlayMusic(ScriptContext *ctx);
BOOL ScrCmd_StopMusic(ScriptContext *ctx);
BOOL ScrCmd_PlayDefaultMusic(ScriptContext *ctx);
BOOL ScrCmd_SetSpecialBGM(ScriptContext *ctx);
BOOL ScrCmd_FadeOutBGM(ScriptContext *ctx);
BOOL ScrCmd_FadeInBGM(ScriptContext *ctx);
BOOL ScrCmd_SetBGMPlayerPaused(ScriptContext *ctx);
BOOL ScrCmd_057(ScriptContext *ctx);
BOOL ScrCmd_SetBGMFixed(ScriptContext *ctx);
BOOL ScrCmd_PlayFanfare(ScriptContext *ctx);
BOOL ScrCmd_StopFanfare(ScriptContext *ctx);
BOOL ScrCmd_WaitFanfare(ScriptContext *ctx);
BOOL ScrCmd_PlayCry(ScriptContext *ctx);
BOOL ScrCmd_WaitCry(ScriptContext *ctx);
BOOL ScrCmd_PlaySound(ScriptContext *ctx);
BOOL ScrCmd_WaitSound(ScriptContext *ctx);
BOOL ScrCmd_CheckRecordedChatotCryIsPlayable(ScriptContext *ctx);
BOOL ScrCmd_TryRecordChatotCry(ScriptContext *ctx);
BOOL ScrCmd_StopRecordingChatotCry(ScriptContext *ctx);
BOOL ScrCmd_StoreRecordedChatotCry(ScriptContext *ctx);
BOOL ScrCmd_SetSubScene63(ScriptContext *ctx);
BOOL ScrCmd_SetInitialVolumeForSequence(ScriptContext *ctx);
BOOL ScrCmd_SetScene22(ScriptContext *ctx);
BOOL ScrCmd_SetFieldScene(ScriptContext *ctx);
BOOL ScrCmd_GetCurrentBGM(ScriptContext *ctx);
#endif // POKEPLATINUM_SCRCMD_SOUND_H