Client

Here you can find any functions and events you can use to customize your experience. Please do not edit this stuff if you don't know what you are doing.

Functions

DoActionsBeforeMinigameInit

• This function is called when you open the minigame menu.

• Example:

  • Hide some UI of other script to not overlap with the minigame.

1. Go to rcore_dance\client\api\cl-api-minigame.lua

2. Edit body of function DoActionsBeforeMinigameInit

DoActionsAfterMinigameEnd

• This function is called when minigame ends and you close it.

• Example:

  • Show the UI that was hidden before the minigame started.

1. Go to rcore_dance\client\api\cl-api-minigame.lua

2. Edit body of function DoActionsAfterMinigameEnd

Events

openMinigameTypeMenu

• This event will open the menu where you can choose the minigame type if you are not already in a menu.

TriggerEvent('rcore_dance:client:openMinigameTypeMenu')

openSoloMinigameMenu

• This event will open the menu for Rhythm Mastery minigame type where you can configure and start it.

TriggerEvent('rcore_dance:client:openSoloMinigameMenu')

openBattleMinigameMenu

• This event will open the menu for Beat Battle minigame type where you can configure and start it.

TriggerEvent('rcore_dance:client:openBattleMinigameMenu')

openFreestyleMinigameMenu

• This event will open the menu for Freestyle Fiesta minigame type where you can configure and start it.

TriggerEvent('rcore_dance:client:openFreestyleMinigameMenu')

endMinigame

• This event will end the current dance minigame.

---@param isForced bool | Whether to force end minigame immediately (if false, player will do animation to pickup mat etc.)
---@param endedBySessionHost bool | Whether the session host ended the minigame (will also cancel session for client)
---@param dontResetMinimap bool | Whether to not reset the minimap (if true, minimap will not appear back if hidden)

TriggerEvent('rcore_dance:client:endMinigame', isForced, endedBySessionHost, dontResetMinimap)