Skip to content
Epitaph Docs

Event Callbacks

These are the callbacks Epitaph calls while your script is loaded and enabled.

Lifecycle-Like Events

Section titled “Lifecycle-Like Events”
  • on_client_started
  • on_disconnect
  • on_world_change
  • on_death
  • on_kill

Tick and Input

Section titled “Tick and Input”
  • on_tick
  • on_pre_tick
  • on_post_tick
  • on_key
  • on_attack
  • on_handle_input
  • on_pre_handle_input
  • on_post_handle_input
  • on_mouse_update
  • on_pre_mouse_update
  • on_post_mouse_update

Movement and Targeting

Section titled “Movement and Targeting”
  • on_move
  • on_pre_move
  • on_post_move
  • on_player_jump
  • on_pre_player_jump
  • on_post_player_jump
  • on_player_travel
  • on_pre_player_travel
  • on_post_player_travel
  • on_update_crosshair_target
  • on_pre_update_crosshair_target
  • on_post_update_crosshair_target

Rendering and Network

Section titled “Rendering and Network”
  • on_render_2d
  • on_render_3d
  • on_packet_send
  • on_packet_receive

Base Event Fields

Section titled “Base Event Fields”

Every event table includes:

  • name
  • cancelled
  • cancel.call
  • set_cancelled.call(true_or_false)

Event-Specific Fields

Section titled “Event-Specific Fields”

on_tick

Section titled “on_tick”
  • phase

on_key

Section titled “on_key”
  • key
  • action
  • pressed
  • released
  • repeat
  • is_mouse
  • mouse_button when the key event came from a mouse button

on_handle_input

Section titled “on_handle_input”
  • phase

on_mouse_update

Section titled “on_mouse_update”
  • phase

on_render_2d

Section titled “on_render_2d”
  • width
  • height
  • tick_delta

on_render_3d

Section titled “on_render_3d”
  • tick_delta
  • camera_x
  • camera_y
  • camera_z

on_move

Section titled “on_move”
  • phase
  • x
  • y
  • z
  • on_ground
  • yaw
  • pitch

on_player_jump

Section titled “on_player_jump”
  • phase
  • yaw

on_player_travel

Section titled “on_player_travel”
  • phase
  • x
  • y
  • z

on_update_crosshair_target

Section titled “on_update_crosshair_target”
  • phase
  • tick_progress

on_packet_send

Section titled “on_packet_send”
  • packet_name

on_packet_receive

Section titled “on_packet_receive”
  • packet_name

on_attack

Section titled “on_attack”
  • entity_id
  • entity_name

on_death

Section titled “on_death”
  • source_name

on_kill

Section titled “on_kill”
  • source_name
  • victim_name
  • attacker_name

on_world_change

Section titled “on_world_change”
  • has_world
  • dimension when a world is present

Example

Section titled “Example”
script = {
  name: "Event Demo",
  description: "Shows key and render event usage.",
  category: "MISC",


  on_key: lambda do |event|
    return unless event.pressed
    client.message("Pressed key #{event.key}")
  end,


  on_render_2d: lambda do |event|
    return unless event.width > 0
    white = render.color(255, 255, 255, 255)
    render.text("tick=#{event.tick_delta}", 8.0, event.height - 16.0, white, false)
  end
}