List of GameEventType Events

From JFTSE Wiki
Jump to navigation Jump to search

List of Events (GameEventType)

This page lists the currently available events you can hook into using the geb.on("EVENT_NAME", ...) function from JavaScript.

All events come from the GameEventType enum in either the game server or chat server codebase. These are used in event scripts placed inside scripts/event/.

Game Server Events

Event Name Called? Parameters Description
ON_TICK ✅ long diff Called on every server tick
ON_LOGIN ✅ FTClient Player logs in
ON_LOGOUT ❌ Player logs out
CHALLENGE_INIT_HP ❌
CHALLENGE_DAMAGE ❌
CHALLENGE_POINT ❌
CHALLENGE_FINISH ❌
EMBLEM_INIT ❌
ENCHANT_ON_ANNOUNCE ❌
ON_ENCHANT ✅ FTClient, PlayerPocket itemPocket, int costs Called after a successfull enchant. It gives you the enchanted inventory item and the cost (gold) of the enchanting itself
GACHA_OPENED ✅ FTClient, int productIndex, List<GachaOpenResult> Called after gacha opening. You get the opening gacha productItemIndex and the result of the opening
RECIPE_COMBINED ✅ FTClient, Recipe Called after a recipe was combined
INVENTORY_ITEM_TIME_EXPIRED ❌ Time-based item expired
ON_PLAYER_ANNOUNCE ❌
PLAYER_QUICK_SLOT_USE ✅ FTClient, int slotIndex Called in matchplay when quick slot is used
LOBBY_JOINED ❌ Player entered the lobby
LOBBY_LEFT ❌ Player left the lobby
ROOM_LOBBY_JOINED ❌
ROOM_CREATED ❌
ROOM_JOINED ❌ Player joined a room
ROOM_LEFT ❌ Player left a room
ROOM_POSITION_CHANGED ❌
ROOM_MAP_CHANGED ❌
MP_RELAY_CONNECTED ❌
MP_GAME_ANIM_SKIP_TRIGGERED ✅ FTClient, Room, RoomPlayer After skipping the match intro, this is called before Player stats are sent to the client
MP_GAME_ANIM_SKIP_END ✅ MatchplayGame, Room Skipping match intro finished and is called right before guardian serve in battle or guardian mode, or serve in basic mode
MP_MATCH_START ❌ Match begins
MP_MATCH_END ✅ MatchplayBasicGame / MatchplayBattleGame / MatchplayGuardianGame, Room, ConcurrentLinkedDeque<FTClient> Match ends. Game object can be one of these three
MP_PLAYER_USE_SKILL ✅ FTClient, MatchplayGame, RoomPlayer, Skill, SkillUse, C2SMatchplayUsesSkill A skill was used
MP_PLAYER_PICKING_UP_CRYSTAL ✅ FTClient, SkillCrystal, int randomSkillIndex Player crystal pickup
MP_PLAYER_HITS_TARGET ✅

(1) FTClient, MatchplayGame, Skill

(2) FTConnection, MatchplayGame, short newHealth, C2SMatchplaySkillHitsTarget

(3) FTConnection, MatchplayGame, short newHealth, Skill, C2SMatchplaySkillHitsTarget

Supports multiple overloads. A target is hit during battle or guardian mode. See Event MP_PLAYER_HITS_TARGET
MP_PLAYER_SWAP_QUICK_SLOT_ITEMS ❌
MP_BALL_HIT ✅ MatchBallSyncMessage A ball hit got registered (only MP, no solo-play!)
SHOP_MAINTENANCE_REQUESTED ❌
ON_SHOP_LOAD ❌
ON_SHOP_LOAD_PREPARE ❌
SHOP_ITEM_BOUGHT ✅ FTClient, List<PlayerPocket>, int costsGold, int costsAp Called after an item is bought. Provides the result of the shopping and its costs
TUTORIAL_INIT ❌
TUTORIAL_FINISH ❌
ON_DEV_PACKET ❌ Developer-only test packet
SESSION_TIME_UPDATE ❌
ON_HEARTBEAT ❌

Chat Server Events

Event Name Called? Parameters Description
ON_TICK ✅ long diff Called on every server tick
ON_LOGIN ✅ FTClient Player logs in
ON_LOGOUT ❌ Player logs out
SHOP_ITEM_BOUGHT ✅ FTClient, List<PlayerPocket>, int costsGold, int costsAp Called after an item is bought. Provides the result of the shopping and its costs
RECIPE_COMBINED ✅ FTClient, Recipe Called after a recipe was combined
ON_ENCHANT ✅ FTClient, PlayerPocket itemPocket, int costs Called after a successfull enchant. It gives you the enchanted inventory item and the cost (gold) of the enchanting itself
GACHA_OPENED ✅ FTClient, int productIndex, List<GachaOpenResult> Called after gacha opening. You get the opening gacha productItemIndex and the result of the opening
TREE_SHAKE_SUCCESS ✅ FTClient, ItemMaterial reward Called when the tree shaking mini game ends successfully
FISHING_SUCCESS ✅ FTClient, Product reward Called when the fishing mini game ends successfully

Legend

✅
Event is currently called (triggered by the server)
❌
Event exists but is not currently triggered


In the "Parameters " column, Java types are shown (e.g. FTClient, MatchplayGame), not variable names.
This is to help you identify the object classes you can interact with inside your script.


Don't see your needed event called yet? → You can still write scripts using them and ask for the event to be wired on Discord. Include the event name and what parameters your handler expects.

Event Lists