#About the game's events
This page lists the events the game raises, with what each one carries. An achievement can wait for one, and a mod's code can hook the function that raises it.
An achievement's when (luma.json pre_standard.achievements) names one of these events by its lower-case name
(star_get), with the name and value it must carry. A mod's code hooks the game function that raises it
(LumaScript hook before or hook after; see Hooks; in C, luma.h). An event nothing
waits for costs the game one load and one branch.
| Event | When, and what it carries |
|---|---|
NEBULA_MOD_EVENT_FRAME |
Every frame, in every scene including menus. |
NEBULA_MOD_EVENT_STAGE_FRAME |
Every frame of a stage, before objects move. |
NEBULA_MOD_EVENT_STAGE_START |
A stage started. name: the stage. value: the mission. |
NEBULA_MOD_EVENT_PLAYER_DAMAGE |
The player is about to lose one health. Return 0 to cancel the hit. |
NEBULA_MOD_EVENT_PLAYER_MISS |
The player is about to die. value: the cause (0 is falling out of the level). Return -1 to cancel. |
NEBULA_MOD_EVENT_POWER_UP |
The player's power-up is about to change. value: the new one (NEBULA_POWER_UP_*). The return value is used. |
NEBULA_MOD_EVENT_COIN |
Coins are about to be added. value: how many. The return value is added instead. |
NEBULA_MOD_EVENT_STAR_BIT |
Star bits are about to be added. value: how many. The return value is added instead. |
NEBULA_MOD_EVENT_STAR_GET |
A star was collected. name: the galaxy. value: the star number. |
NEBULA_MOD_EVENT_CUTSCENE_START |
A cutscene started or ended. name: the cutscene. |
NEBULA_MOD_EVENT_CUTSCENE_END |
A cutscene started or ended. name: the cutscene. |
NEBULA_MOD_EVENT_ACTOR_APPEAR |
An object appeared or was killed. actor: the object. name: its name. Costs one call per object. |
NEBULA_MOD_EVENT_ACTOR_KILL |
An object appeared or was killed. actor: the object. name: its name. Costs one call per object. |
NEBULA_MOD_EVENT_PLAYER_SPIN |
The player started a spin. |
NEBULA_MOD_EVENT_PLAYER_JUMP |
The player jumped off the ground, or landed. |
NEBULA_MOD_EVENT_PLAYER_LAND |
The player jumped off the ground, or landed. |
NEBULA_MOD_EVENT_PAUSE |
The pause menu opened (value 1) or closed (value 0). |
NEBULA_MOD_EVENT_STAGE_END |
The stage is ending; all its actors and layouts are destroyed after this. name: the stage. |
NEBULA_MOD_EVENT_GAME_SAVE |
The game is about to write the save. |
NEBULA_MOD_EVENT_POWER_STAR_APPEAR |
A power star appeared in the stage. value: its number. |
NEBULA_MOD_EVENT_TALK_LINE |
A line of dialogue opened in its balloon. actor: the speaker. name: the message id, as luma.json "text" uses it (null for a line without an id). |
NEBULA_MOD_EVENT_TALK_CHOICE |
The player answered a yes/no question. value: 1 yes, 0 no. actor: who asked. name: the question's message id. |
NEBULA_MOD_EVENT_CUTSCENE_PART |
A part of a cutscene started. value: the part's index, from 0. name: the part's name in the cutscene's time sheet. |
NEBULA_MOD_EVENT_CAMERA_CHANGE |
The camera changed. value: 0 for an area camera (also when the last event camera ends), 1 for an event camera. name: its id in the stage's camera table. |
NEBULA_MOD_EVENT_SOUND_START |
A sound effect is about to play. value: its number. name: its name. The returned number plays instead (the same, another sound's, or -1 for silence). Costs one call per sound. |
NEBULA_MOD_EVENT_EFFECT_START |
An object started an effect. actor: the object. name: the effect's name in the object's effect table. |
NEBULA_MOD_EVENT_SCREEN |
A screen layout (a counter, a menu, a message box) was shown (value 1) or removed (value 0). name: its name in the game's code. |
NEBULA_MOD_EVENT_ACTOR_MESSAGE |
An object received a message from another: an attack, a stomp, a push, a grab (numbers in docs/modding/EVENTS.md). actor: the receiver. name: its name. value: the message. Return -1 to cancel it. |
NEBULA_MOD_EVENT_PLAYER_ACTION |
The player started an action: swimming, hanging, sliding, falling (numbers in docs/modding/EVENTS.md). value: the action. |
#Messages (NEBULA_MOD_EVENT_ACTOR_MESSAGE)
The game's objects talk through messages: the player's stomp on a Goomba is ACTMES_PLAYER_TRAMPLE sent to it.
Ranges: the player's attacks lie between ACTMES_PLAYER_ATTACK_START and ACTMES_PLAYER_ATTACK_END, enemies'
between ACTMES_ENEMY_ATTACK_START and ACTMES_ENEMY_ATTACK_END.
| Message | Number |
|---|---|
ACTMES_PLAYER_ATTACK_START |
0 (0x0) |
ACTMES_PLAYER_PUNCH |
1 (0x1) |
ACTMES_PLAYER_TRAMPLE |
2 (0x2) |
ACTMES_PLAYER_HIP_DROP |
3 (0x3) |
ACTMES_PLAYER_HIP_DROP_FLOOR |
4 (0x4) |
ACTMES_PLAYER_UPPER_PUNCH |
5 (0x5) |
ACTMES_JET_TURTLE_ATTACK |
6 (0x6) |
ACTMES_FOO_ATTACK |
7 (0x7) |
ACTMES_FIREBALL_ATTACK |
8 (0x8) |
ACTMES_SEARCHLIGHT_ATTACK |
9 (0x9) |
ACTMES_FREEZE_ATTACK |
10 (0xA) |
ACTMES_INVINCIBLE_ATTACK |
11 (0xB) |
ACTMES_STAR_PIECE_ATTACK |
12 (0xC) |
ACTMES_IS_STAR_PIECE_REFLECT |
13 (0xD) |
ACTMES_IS_LOCKON_STAR_PIECE_SHOOT |
14 (0xE) |
ACTMES_STAR_PIECE_GIFT |
15 (0xF) |
ACTMES_STAR_PIECE_GIFT_1 |
16 (0x10) |
ACTMES_STAR_PIECE_GIFT_MAX |
25 (0x19) |
ACTMES_PLAYER_ATTACK_END |
26 (0x1A) |
ACTMES_IS_PUNCH_ENABLE |
27 (0x1B) |
ACTMES_HITMARK_EMIT |
28 (0x1C) |
ACTMES_INVALID_HIT |
29 (0x1D) |
ACTMES_TAKE |
30 (0x1E) |
ACTMES_TAKEN |
31 (0x1F) |
ACTMES_APART |
33 (0x21) |
ACTMES_THROW |
34 (0x22) |
ACTMES_DAMAGEDROP |
35 (0x23) |
ACTMES_RUSHDROP |
36 (0x24) |
ACTMES_ATTACKDROP |
37 (0x25) |
ACTMES_HANG_CANCEL |
38 (0x26) |
ACTMES_SHAKE_OFF_BEE |
39 (0x27) |
ACTMES_TAKE_TOUCH |
40 (0x28) |
ACTMES_PUSH |
41 (0x29) |
ACTMES_PUSH_FORCE |
42 (0x2A) |
ACTMES_KICK |
43 (0x2B) |
ACTMES_JUMP |
44 (0x2C) |
ACTMES_TOUCHJUMP |
45 (0x2D) |
ACTMES_BILLIARDJUMP |
46 (0x2E) |
ACTMES_AWAYJUMP |
47 (0x2F) |
ACTMES_TORNADO_ATTACK |
49 (0x31) |
ACTMES_TORNADO_STORM_RANGE |
50 (0x32) |
ACTMES_SPIN_STORM_RANGE |
51 (0x33) |
ACTMES_BALL_TOUCH_WALL |
54 (0x36) |
ACTMES_BALL_DASH_WALL |
57 (0x39) |
ACTMES_BALL_DASH_GROUND |
58 (0x3A) |
ACTMES_BIG_BUBBLE_MERGE |
60 (0x3C) |
ACTMES_BIG_BUBBLE_ASSIMILATE |
62 (0x3E) |
ACTMES_REFLECT |
63 (0x3F) |
ACTMES_REFLECT_V |
64 (0x40) |
ACTMES_IS_BROKEN |
65 (0x41) |
ACTMES_PASS_RING |
66 (0x42) |
ACTMES_FOUNTAINJUMP |
67 (0x43) |
ACTMES_TERESA_PLAYER_TOUCH |
68 (0x44) |
ACTMES_RUSH_PLAYER_TOUCH |
69 (0x45) |
ACTMES_BOMB_TERESA_TONGUE_TOUCH |
70 (0x46) |
ACTMES_PUDDLE_TOUCH_GROUND |
71 (0x47) |
ACTMES_WARP |
72 (0x48) |
ACTMES_ASK_HIDDEN_BY_SNOW |
73 (0x49) |
ACTMES_NOTIFY_DISCOVER_SNOW |
74 (0x4A) |
ACTMES_ENEMY_ATTACK_START |
75 (0x4B) |
ACTMES_ENEMY_ATTACK_FLIP_VERYWEAK |
76 (0x4C) |
ACTMES_ENEMY_ATTACK_FLIP_WEAK |
77 (0x4D) |
ACTMES_ENEMY_ATTACK_FLIP_WEAK_JUMP |
78 (0x4E) |
ACTMES_ENEMY_ATTACK_FLIP_JUMP |
79 (0x4F) |
ACTMES_ENEMY_ATTACK_FLIP |
80 (0x50) |
ACTMES_ENEMY_ATTACK_FLIP_ROT |
81 (0x51) |
ACTMES_ENEMY_ATTACK_FLIP_MAXIMUM |
82 (0x52) |
ACTMES_ENEMY_ATTACK |
83 (0x53) |
ACTMES_ENEMY_ATTACK_STRONG |
84 (0x54) |
ACTMES_ENEMY_ATTACK_MAXIMUM |
85 (0x55) |
ACTMES_ENEMY_ATTACK_EXPLOSION |
86 (0x56) |
ACTMES_ENEMY_ATTACK_FIREBACK |
87 (0x57) |
ACTMES_ENEMY_ATTACK_FIRERUN |
88 (0x58) |
ACTMES_ENEMY_ATTACK_FIRERUN_STRONG |
89 (0x59) |
ACTMES_ENEMY_ATTACK_ELECTRIC |
90 (0x5A) |
ACTMES_ENEMY_ATTACK_HEATBEAM |
91 (0x5B) |
ACTMES_ENEMY_ATTACK_ACID |
92 (0x5C) |
ACTMES_ENEMY_ATTACK_FREEZE |
93 (0x5D) |
ACTMES_ENEMY_ATTACK_CRUSH |
94 (0x5E) |
ACTMES_ENEMY_ATTACK_EXTRA_DAMAGE |
95 (0x5F) |
ACTMES_ENEMY_ATTACK_COUNTER_SPIN |
96 (0x60) |
ACTMES_ENEMY_ATTACK_COUNTER_HIPDROP |
97 (0x61) |
ACTMES_TO_ENEMY_ATTACK_BLOW |
98 (0x62) |
ACTMES_TO_ENEMY_ATTACK_TRAMPLE |
99 (0x63) |
ACTMES_TO_ENEMY_ATTACK_SHOCK_WAVE |
100 (0x64) |
ACTMES_ENEMY_ATTACK_END |
101 (0x65) |
ACTMES_SUCCESS |
102 (0x66) |
ACTMES_FAILURE |
103 (0x67) |
ACTMES_GROUP_MOVE_START |
104 (0x68) |
ACTMES_GROUP_MOVE_STOP |
105 (0x69) |
ACTMES_GROUP_ATTACK |
106 (0x6A) |
ACTMES_GROUP_SHOW |
107 (0x6B) |
ACTMES_GROUP_HIDE |
108 (0x6C) |
ACTMES_GROUP_LOD_LOW |
109 (0x6D) |
ACTMES_START_DEMO |
111 (0x6F) |
ACTMES_END_DEMO |
112 (0x70) |
ACTMES_FORCE_KILL |
113 (0x71) |
ACTMES_INHALE_BLACK_HOLE |
115 (0x73) |
ACTMES_START_POWER_STAR_GET |
116 (0x74) |
ACTMES_ITEM_GET |
135 (0x87) |
ACTMES_IS_PULL_ENABLE |
136 (0x88) |
ACTMES_ITEM_PULL |
137 (0x89) |
ACTMES_ITEM_SHOW |
138 (0x8A) |
ACTMES_ITEM_HIDE |
139 (0x8B) |
ACTMES_ITEM_START_MOVE |
140 (0x8C) |
ACTMES_ITEM_END_MOVE |
141 (0x8D) |
ACTMES_OPD_SHOOT |
142 (0x8E) |
ACTMES_IS_OPD_SITE_IN |
143 (0x8F) |
ACTMES_RUSH_BEGIN |
145 (0x91) |
ACTMES_AUTORUSH_BEGIN |
146 (0x92) |
ACTMES_RUSH_CANCEL |
147 (0x93) |
ACTMES_RUSH_FORCE_CANCEL |
148 (0x94) |
ACTMES_RUSH_DAMAGE_CANCEL |
149 (0x95) |
ACTMES_RUSH_END |
150 (0x96) |
ACTMES_IS_RUSH_ENABLE |
151 (0x97) |
ACTMES_IS_RUSH_TAKEOVER |
152 (0x98) |
ACTMES_IS_RUSH_REQUEST |
153 (0x99) |
ACTMES_SLING_SHOOT_ACTOR_HANG_START |
155 (0x9B) |
ACTMES_SLING_SHOOT_ACTOR_HANG_END |
156 (0x9C) |
ACTMES_SLING_SHOOT_ACTOR_APART |
157 (0x9D) |
ACTMES_SLING_SHOOT_ATTACK |
158 (0x9E) |
ACTMES_SLING_SHOOT_PASS_THROUGH_ENABLE |
159 (0x9F) |
ACTMES_SLING_SHOOT_IS_LAST_DAMAGE |
160 (0xA0) |
ACTMES_UPDATE_BASEMTX |
161 (0xA1) |
ACTMES_TRIPODBOSS_LEG_IS_DAMAGE |
169 (0xA9) |
ACTMES_TRIPODBOSS_STARTED |
170 (0xAA) |
ACTMES_DISPERSE_BOMB_TERESA |
171 (0xAB) |
ACTMES_BREAK_POLTA_GROUND_ROCK |
172 (0xAC) |
ACTMES_SPHERE_PLAYER_BINDED |
173 (0xAD) |
ACTMES_SET_UP_JUMP_HOLE |
174 (0xAE) |
ACTMES_SHOOT_JUMP_HOLE |
175 (0xAF) |
ACTMES_END_JUMP_HOLE |
176 (0xB0) |
ACTMES_END_RAIL_DASH |
177 (0xB1) |
ACTMES_END_BALL_RAIL |
178 (0xB2) |
ACTMES_END_BALL_BIND |
179 (0xB3) |
ACTMES_FLOOR_TOUCH |
180 (0xB4) |
ACTMES_WALL_TOUCH |
181 (0xB5) |
ACTMES_CEIL_TOUCH |
182 (0xB6) |
ACTMES_REQUEST_CLAP |
183 (0xB7) |
ACTMES_DINO_PACKUN_PUNCHED_BALL |
184 (0xB8) |
ACTMES_DINO_PACKUN_PULLED_TAIL |
185 (0xB9) |
ACTMES_DINO_PACKUN_BALL_ATTACK |
186 (0xBA) |
ACTMES_TOMB_SPIDER_BATTLE_START |
187 (0xBB) |
ACTMES_TOMB_SPIDER_DEMO_START |
188 (0xBC) |
ACTMES_SKELETAL_FISH_BOSS_BATTLE_START |
190 (0xBE) |
ACTMES_SKELETAL_FISH_BOSS_BATTLE_END |
191 (0xBF) |
ACTMES_KOOPA_HIP_DROP_ATTACK |
192 (0xC0) |
ACTMES_KOOPA_PLAYER_DAMAGE |
193 (0xC1) |
ACTMES_KOOPA_PLATE_DAMAGE |
194 (0xC2) |
ACTMES_TICO_RAIL_TOUCH |
195 (0xC3) |
ACTMES_IS_REFLECTION_G_CAPTURE |
196 (0xC4) |
ACTMES_IS_NO_BREAK_G_CAPTURE |
197 (0xC5) |
ACTMES_TURNIP_ATTACK |
198 (0xC6) |
ACTMES_PAKKUN_BALL_ATTACK |
199 (0xC7) |
ACTMES_MAPPARTS_ON_PLAYER |
202 (0xCA) |
ACTMES_MAPPARTS_START_ROTATE_AT_POINT |
203 (0xCB) |
ACTMES_MAPPARTS_END_ROTATE_AT_POINT |
204 (0xCC) |
ACTMES_MAPPARTS_START_ROTATE_BETWEEN_POINTS |
205 (0xCD) |
ACTMES_MAPPARTS_DISAPPEAR_WITH_BLINK |
207 (0xCF) |
ACTMES_NPC_EVENT_START |
208 (0xD0) |
ACTMES_NPC_EVENT_END |
209 (0xD1) |
ACTMES_NPC_EVENT_TALK_ENABLE |
210 (0xD2) |
ACTMES_NPC_EVENT_TALK_DISABLE |
211 (0xD3) |
ACTMES_NPC_TALK_NEXT |
212 (0xD4) |
ACTMES_SPHERE_SELECTOR_SELECT_START |
224 (0xE0) |
ACTMES_SPHERE_SELECTOR_SELECT_END |
225 (0xE1) |
ACTMES_SPHERE_SELECTOR_CONFIRM_START |
226 (0xE2) |
ACTMES_SPHERE_SELECTOR_CONFIRM_CANCEL |
227 (0xE3) |
ACTMES_SPHERE_SELECTOR_CONFIRMED |
228 (0xE4) |
ACTMES_SPHERE_SELECTOR_TARGET_SELECTED |
229 (0xE5) |
ACTMES_TUTORIAL_START |
230 (0xE6) |
ACTMES_TUTORIAL_NEXT |
231 (0xE7) |
ACTMES_TUTORIAL_PREV |
232 (0xE8) |
ACTMES_TUTORIAL_PASS |
233 (0xE9) |
ACTMES_TUTORIAL_OMIT |
235 (0xEB) |
ACTMES_RACE_READY |
236 (0xEC) |
ACTMES_RACE_START |
237 (0xED) |
ACTMES_RACE_GOAL |
238 (0xEE) |
ACTMES_RACE_RESET |
239 (0xEF) |
ACTMES_HEAVENSDOOR_RUNAWAY_RABBIT_WAIT |
240 (0xF0) |
ACTMES_HEAVENSDOOR_RUNAWAY_RABBIT_START |
241 (0xF1) |
ACTMES_LAUNCHER_BREAKABLE |
242 (0xF2) |
ACTMES_PLANT_GROUP_EMIT_ITEM |
243 (0xF3) |
#Player actions (NEBULA_MOD_EVENT_PLAYER_ACTION)
Actions the player's code runs on its own (the ordinary moves, running and jumping, are not actions here: they come as PLAYER_JUMP, PLAYER_LAND and PLAYER_SPIN). Names sharing a number are one action.
| Action | Number |
|---|---|
MarioStatus_None |
0 |
MarioStatus_Wall |
1 |
MarioStatus_Damage |
2 |
MarioStatus_Faint |
3 |
MarioStatus_Blown |
4 |
MarioStatus_Hang |
5 |
MarioStatus_Swim |
6 |
MarioStatus_Slider |
7 |
MarioStatus_FireDamage |
8 |
MarioStatus_FireDance |
9 |
MarioStatus_FireRun |
10 |
MarioStatus_Paralyze |
11 |
MarioStatus_AbyssDamage |
12 |
MarioStatus_Freeze |
13 |
MarioStatus_Stun |
14 |
MarioStatus_Crush |
15 |
MarioStatus_Step |
16 |
MarioStatus_Magic |
17 |
MarioStatus_FpView |
18 |
MarioStatus_RecoveryOrWarp |
19 |
MarioStatus_Recovery |
19 |
MarioStatus_Warp |
19 |
MarioStatus_Flip |
20 |
MarioStatus_SideStep |
21 |
MarioStatus_Stick |
22 |
MarioStatus_Rabbit |
23 |
MarioStatus_Foo |
24 |
MarioStatus_Flow |
25 |
MarioStatus_Sukekiyo |
26 |
MarioStatus_Bury |
27 |
MarioStatus_Wait |
28 |
MarioStatus_Climb |
29 |
MarioStatus_Bump |
30 |
MarioStatus_Skate |
31 |
MarioStatus_FrontStep |
32 |
MarioStatus_Teresa |
33 |
MarioStatus_Talk |
34 |
MarioStatus_DarkDamage |
35 |