evt.h File Reference

Macros
#define	MAKE_ENTITY_END   0x80000000
#define	EVT_CONTINUE   0 /* Continue to next command */
#define	EVT_ABORT   1 /* Quit execution */
#define	EVT_FINISH   255 /* Return from script */
#define	ApiStatus_BLOCK   0 /* Call again next frame */
#define	ApiStatus_DONE1   1 /* Unconditional. Probably only exists to return a bool from functions */
#define	ApiStatus_DONE2   2 /* Conditional on Evt->disableScripts */
#define	ApiStatus_REPEAT   3 /* Call again immediately */
#define	ApiStatus_FINISH   255 /* Corresponds to EVT_FINISH */

Typedefs
typedef s32	Bytecode
typedef s32	ApiStatus

Enumerations
enum	{   EVT_OP_INTERNAL_FETCH , EVT_OP_END , EVT_OP_RETURN , EVT_OP_LABEL ,   EVT_OP_GOTO , EVT_OP_LOOP , EVT_OP_END_LOOP , EVT_OP_BREAK_LOOP ,   EVT_OP_WAIT_FRAMES , EVT_OP_WAIT_SECS , EVT_OP_IF_EQ , EVT_OP_IF_NE ,   EVT_OP_IF_LT , EVT_OP_IF_GT , EVT_OP_IF_LE , EVT_OP_IF_GE ,   EVT_OP_IF_FLAG , EVT_OP_IF_NOT_FLAG , EVT_OP_ELSE , EVT_OP_END_IF ,   EVT_OP_SWITCH , EVT_OP_SWITCH_CONST , EVT_OP_CASE_EQ , EVT_OP_CASE_NE ,   EVT_OP_CASE_LT , EVT_OP_CASE_GT , EVT_OP_CASE_LE , EVT_OP_CASE_GE ,   EVT_OP_CASE_DEFAULT , EVT_OP_CASE_OR_EQ , EVT_OP_CASE_AND_EQ , EVT_OP_CASE_FLAG ,   EVT_OP_END_CASE_GROUP , EVT_OP_CASE_RANGE , EVT_OP_BREAK_SWITCH , EVT_OP_END_SWITCH ,   EVT_OP_SET , EVT_OP_SET_CONST , EVT_OP_SETF , EVT_OP_ADD ,   EVT_OP_SUB , EVT_OP_MUL , EVT_OP_DIV , EVT_OP_MOD ,   EVT_OP_ADDF , EVT_OP_SUBF , EVT_OP_MULF , EVT_OP_DIVF ,   EVT_OP_USE_BUF , EVT_OP_BUF_READ1 , EVT_OP_BUF_READ2 , EVT_OP_BUF_READ3 ,   EVT_OP_BUF_READ4 , EVT_OP_BUF_PEEK , EVT_OP_USE_FBUF , EVT_OP_FBUF_READ1 ,   EVT_OP_FBUF_READ2 , EVT_OP_FBUF_READ3 , EVT_OP_FBUF_READ4 , EVT_OP_FBUF_PEEK ,   EVT_OP_USE_ARRAY , EVT_OP_USE_FLAGS , EVT_OP_MALLOC_ARRAY , EVT_OP_BITWISE_AND ,   EVT_OP_BITWISE_AND_CONST , EVT_OP_BITWISE_OR , EVT_OP_BITWISE_OR_CONST , EVT_OP_CALL ,   EVT_OP_EXEC , EVT_OP_EXEC_GET_TID , EVT_OP_EXEC_WAIT , EVT_OP_BIND_TRIGGER ,   EVT_OP_UNBIND , EVT_OP_KILL_THREAD , EVT_OP_JUMP , EVT_OP_SET_PRIORITY ,   EVT_OP_SET_TIMESCALE , EVT_OP_SET_GROUP , EVT_OP_BIND_PADLOCK , EVT_OP_SUSPEND_GROUP ,   EVT_OP_RESUME_GROUP , EVT_OP_SUSPEND_OTHERS , EVT_OP_RESUME_OTHERS , EVT_OP_SUSPEND_THREAD ,   EVT_OP_RESUME_THREAD , EVT_OP_IS_THREAD_RUNNING , EVT_OP_THREAD , EVT_OP_END_THREAD ,   EVT_OP_CHILD_THREAD , EVT_OP_END_CHILD_THREAD , EVT_OP_DEBUG_LOG , EVT_OP_DEBUG_PRINT_VAR ,   EVT_OP_92 , EVT_OP_93 , EVT_OP_94 }
enum	EventCommandResults { EVT_CMD_RESULT_YIELD = -1 , EVT_CMD_RESULT_CONTINUE = 0 , EVT_CMD_RESULT_ERROR = 1 }
enum	EventGroupFlags {   EVT_GROUP_00 = 0x00 , EVT_GROUP_0A = 0x0A , EVT_GROUP_0B = 0x0B , EVT_GROUP_1B = 0x1B ,   EVT_GROUP_EF = 0xEF , EVT_GROUP_01 = 0x01 , EVT_GROUP_02 = 0x02 , EVT_GROUP_SHAKE_CAM = 0x04 ,   EVT_GROUP_08 = 0x08 , EVT_GROUP_10 = 0x10 }
enum	EventPriority { EVT_PRIORITY_0 = 0x00 , EVT_PRIORITY_1 = 0x01 , EVT_PRIORITY_A = 0x0A , EVT_PRIORITY_14 = 0x14 }
enum	EventStateFlags {   EVT_FLAG_ACTIVE = 0x01 , EVT_FLAG_SUSPENDED_IN_GROUP = 0x02 , EVT_FLAG_BLOCKED_BY_CHILD = 0x10 , EVT_FLAG_RUN_IMMEDIATELY = 0x20 ,   EVT_FLAG_THREAD = 0x40 , EVT_FLAG_SUSPENDED = 0x80 }

Macro Definition Documentation

ApiStatus_BLOCK

#define ApiStatus_BLOCK   0 /* Call again next frame */

Referenced by _npc_jump_to(), evt_execute_next_command(), evt_handle_end_child_thread(), and player_jump().

ApiStatus_DONE1

#define ApiStatus_DONE1   1 /* Unconditional. Probably only exists to return a bool from functions */

Referenced by _npc_jump_to(), evt_execute_next_command(), func_802C73B8(), and player_jump().

ApiStatus_DONE2

#define ApiStatus_DONE2   2 /* Conditional on Evt->disableScripts */

Referenced by _npc_jump_to(), evt_execute_next_command(), evt_handle_add(), evt_handle_addF(), evt_handle_allocate_array(), evt_handle_AND(), evt_handle_AND_const(), evt_handle_bind(), evt_handle_bind_lock(), evt_handle_break_case(), evt_handle_break_loop(), evt_handle_case_AND(), evt_handle_case_default(), evt_handle_case_equal(), evt_handle_case_equal_AND(), evt_handle_case_equal_OR(), evt_handle_case_greater(), evt_handle_case_greater_equal(), evt_handle_case_less(), evt_handle_case_less_equal(), evt_handle_case_not_equal(), evt_handle_case_range(), evt_handle_child_thread(), evt_handle_debug_log(), evt_handle_divide(), evt_handle_divideF(), evt_handle_does_script_exist(), evt_handle_else(), evt_handle_end_case_group(), evt_handle_end_if(), evt_handle_end_loop(), evt_handle_end_switch(), evt_handle_exec1(), evt_handle_exec1_get_id(), evt_handle_get_1_float(), evt_handle_get_1_word(), evt_handle_get_2_float(), evt_handle_get_2_word(), evt_handle_get_3_float(), evt_handle_get_3_word(), evt_handle_get_4_float(), evt_handle_get_4_word(), evt_handle_get_Nth_float(), evt_handle_get_Nth_word(), evt_handle_goto(), evt_handle_if_AND(), evt_handle_if_equal(), evt_handle_if_greater(), evt_handle_if_greater_equal(), evt_handle_if_less(), evt_handle_if_less_equal(), evt_handle_if_not_AND(), evt_handle_if_not_equal(), evt_handle_jump(), evt_handle_kill(), evt_handle_label(), evt_handle_loop(), evt_handle_mod(), evt_handle_multiply(), evt_handle_multiplyF(), evt_handle_OR(), evt_handle_OR_const(), evt_handle_print_debug_var(), evt_handle_resume(), evt_handle_resume_all(), evt_handle_resume_others(), evt_handle_set_array(), evt_handle_set_const(), evt_handle_set_flag_array(), evt_handle_set_float(), evt_handle_set_float_buffer_ptr(), evt_handle_set_group(), evt_handle_set_int_buffer_ptr(), evt_handle_set_priority(), evt_handle_set_timescale(), evt_handle_set_var(), evt_handle_subtract(), evt_handle_subtractF(), evt_handle_suspend(), evt_handle_suspend_all(), evt_handle_suspend_others(), evt_handle_switch(), evt_handle_switch_const(), evt_handle_thread(), evt_handle_unbind(), evt_handle_wait(), evt_handle_wait_seconds(), func_802C739C(), func_802C73B0(), and SomeVtxFunc().

ApiStatus_FINISH

#define ApiStatus_FINISH   255 /* Corresponds to EVT_FINISH */

Referenced by evt_execute_next_command(), evt_handle_end_thread(), evt_handle_exec_wait(), and evt_handle_return().

ApiStatus_REPEAT

#define ApiStatus_REPEAT   3 /* Call again immediately */

Referenced by evt_execute_next_command().

EVT_ABORT

#define EVT_ABORT   1 /* Quit execution */

EVT_CONTINUE

#define EVT_CONTINUE   0 /* Continue to next command */

EVT_FINISH

#define EVT_FINISH   255 /* Return from script */

MAKE_ENTITY_END

#define MAKE_ENTITY_END   0x80000000

Referenced by create_entity(), entity_breakable_block_create_shattering_entity(), entity_HeartBlock_create_child_entity(), entity_ItemBlock_check_if_inactive(), entity_ItemBlock_replace_with_inactive(), entity_MulticoinBlock_check_if_inactive(), entity_MulticoinBlock_idle(), entity_MulticoinBlock_spawn_coin(), entity_PinkFlower_init(), entity_upgrade_block_check_if_inactive(), and MAP_RODATA_PAD().

Typedef Documentation

ApiStatus

typedef s32 ApiStatus

Bytecode

typedef s32 Bytecode

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
EVT_OP_INTERNAL_FETCH
EVT_OP_END
EVT_OP_RETURN
EVT_OP_LABEL	Args: index.
EVT_OP_GOTO	Args: index.
EVT_OP_LOOP	Args: number of repeats (0 = infinite)
EVT_OP_END_LOOP
EVT_OP_BREAK_LOOP
EVT_OP_WAIT_FRAMES
EVT_OP_WAIT_SECS
EVT_OP_IF_EQ	Args: a, b.
EVT_OP_IF_NE	Args: a, b.
EVT_OP_IF_LT	Args: a, b.
EVT_OP_IF_GT	Args: a, b.
EVT_OP_IF_LE	Args: a, b.
EVT_OP_IF_GE	Args: a, b.
EVT_OP_IF_FLAG	Args: a, b.
EVT_OP_IF_NOT_FLAG	Args: a, b.
EVT_OP_ELSE
EVT_OP_END_IF
EVT_OP_SWITCH	Args: expression to test against.
EVT_OP_SWITCH_CONST	Args: value to test against.
EVT_OP_CASE_EQ	Args: expression to test for.
EVT_OP_CASE_NE	Args: expression to test for.
EVT_OP_CASE_LT	Args: expression to test for.
EVT_OP_CASE_GT	Args: expression to test for.
EVT_OP_CASE_LE	Args: expression to test for.
EVT_OP_CASE_GE	Args: expression to test for.
EVT_OP_CASE_DEFAULT
EVT_OP_CASE_OR_EQ	Args: expression to test for.
EVT_OP_CASE_AND_EQ	Args: expression to test for.
EVT_OP_CASE_FLAG	Args: expression to test for.
EVT_OP_END_CASE_GROUP	Ends the case block of EVT_OP_CASE_OR_EQ condition(s).
EVT_OP_CASE_RANGE	Args: from, to.
EVT_OP_BREAK_SWITCH
EVT_OP_END_SWITCH
EVT_OP_SET	Args: container, expression.
EVT_OP_SET_CONST	Args: container, value.
EVT_OP_SETF	Args: container, expression.
EVT_OP_ADD	Args: container, expression to increment by.
EVT_OP_SUB	Args: container, expression to decrement by.
EVT_OP_MUL	Args: container, expression to multiply by.
EVT_OP_DIV	Integer division. Args: container, expression to divide by.
EVT_OP_MOD	Args: container, expression to divide by.
EVT_OP_ADDF	Args: container, expression to increment by.
EVT_OP_SUBF	Args: container, expression to decrement by.
EVT_OP_MULF	Args: container, expression to multiply by.
EVT_OP_DIVF	Args: container, expression to divide by.
EVT_OP_USE_BUF	Args: s32*.
EVT_OP_BUF_READ1
EVT_OP_BUF_READ2	Args: container.
EVT_OP_BUF_READ3	Args: container, container.
EVT_OP_BUF_READ4	Args: container, container, container.
EVT_OP_BUF_PEEK	Args: container, container, container, container. Args: index, container
EVT_OP_USE_FBUF	Identical to USE_BUFFER. Args: f32*.
EVT_OP_FBUF_READ1
EVT_OP_FBUF_READ2	Args: container.
EVT_OP_FBUF_READ3	Args: container, container.
EVT_OP_FBUF_READ4	Args: container, container, container.
EVT_OP_FBUF_PEEK	Args: container, container, container, container. Args: index, container
EVT_OP_USE_ARRAY	Args: *s32.
EVT_OP_USE_FLAGS	Args: *s32.
EVT_OP_MALLOC_ARRAY	Allocates a new array. Args: length, s32*.
EVT_OP_BITWISE_AND	Args: container, expression to bitwise AND with.
EVT_OP_BITWISE_AND_CONST	Args: container, value to bitwise AND with.
EVT_OP_BITWISE_OR	Args: container, expression to bitwise OR with.
EVT_OP_BITWISE_OR_CONST	Args: container, value to bitwise OR with.
EVT_OP_CALL	Args: *function, ...
EVT_OP_EXEC	Args: EvtScript*.
EVT_OP_EXEC_GET_TID	Args: EvtScript*, container.
EVT_OP_EXEC_WAIT	Spawns a script and waits for it to return before continuing. Args: EvtScript*.
EVT_OP_BIND_TRIGGER	Args: EvtScript*, trigger flags, s32 target, 1, Trigger*.
EVT_OP_UNBIND	Unbinds any triggers bound to this script.
EVT_OP_KILL_THREAD	Args: ScriptID.
EVT_OP_JUMP	Args: EvtScript*.
EVT_OP_SET_PRIORITY	Args: priority.
EVT_OP_SET_TIMESCALE	Args: timescale.
EVT_OP_SET_GROUP	Args: group.
EVT_OP_BIND_PADLOCK	Args: EvtScript*, trigger flags, s32 target, ItemList*, 0, 1.
EVT_OP_SUSPEND_GROUP	Args: group.
EVT_OP_RESUME_GROUP	Args: group.
EVT_OP_SUSPEND_OTHERS	Args: group.
EVT_OP_RESUME_OTHERS	Args: group.
EVT_OP_SUSPEND_THREAD	Args: ScriptID.
EVT_OP_RESUME_THREAD	Args: ScriptID.
EVT_OP_IS_THREAD_RUNNING	Args: ScriptID, container.
EVT_OP_THREAD
EVT_OP_END_THREAD
EVT_OP_CHILD_THREAD	Parallel threads are killed as soon as the parent script returns.
EVT_OP_END_CHILD_THREAD
EVT_OP_DEBUG_LOG
EVT_OP_DEBUG_PRINT_VAR	Args: expression.
EVT_OP_92
EVT_OP_93
EVT_OP_94

EventCommandResults

enum EventCommandResults

Enumerator
EVT_CMD_RESULT_YIELD
EVT_CMD_RESULT_CONTINUE
EVT_CMD_RESULT_ERROR

EventGroupFlags

enum EventGroupFlags

Enumerator
EVT_GROUP_00
EVT_GROUP_0A
EVT_GROUP_0B
EVT_GROUP_1B
EVT_GROUP_EF
EVT_GROUP_01
EVT_GROUP_02
EVT_GROUP_SHAKE_CAM
EVT_GROUP_08
EVT_GROUP_10

EventPriority

enum EventPriority

Enumerator
EVT_PRIORITY_0
EVT_PRIORITY_1
EVT_PRIORITY_A
EVT_PRIORITY_14

EventStateFlags

enum EventStateFlags

Enumerator
EVT_FLAG_ACTIVE
EVT_FLAG_SUSPENDED_IN_GROUP
EVT_FLAG_BLOCKED_BY_CHILD
EVT_FLAG_RUN_IMMEDIATELY	don't wait for next update_scripts call
EVT_FLAG_THREAD
EVT_FLAG_SUSPENDED	doesn't affect child