☎️Events

Usage: events.{event_name}

There are a number of events that Fatality provides to use in the API - from various hooks, to in-game events. Each event entry is an object of event_t. This table documents events to be used by your scripts.

You are not required to remove events when your script unloads. It is done automatically by the API engine.

present_queue

Field

Invoked each time the game queues a frame for rendering. This is the only permitted location for drawing on screen.

Arguments

None.

---

frame_stage_notify

Field

Invoked every time the game progresses onto another frame stage. This event is called before the game handles a new frame stage.

Arguments

Name	Type	Description
stage	client_frame_stage	Current frame stage.

---

render_start_pre

Field

Invoked every time game starts the scene rendering process. This event is called before the game's function runs.

Arguments

None.

---

render_start_post

Field

Invoked every time game starts scene rendering process. This event is called after the game's function runs.

Arguments

Name	Type	Description
setup	cview_setup	View setup information.

---

setup_view_pre

Field

Invoked every time the game sets up the view. This event is called before the game's function runs.

Arguments

None.

---

setup_view_post

Field

Invoked every time the game sets up the view information. This event is called after the game's function runs.

You can retrieve the view information from game.view_render service.

Arguments

None.

---

override_view

Field

Invoked every time the game internally overrides view information. You are free to change whatever you like in the provided view setup.

Arguments

Name	Type	Description
setup	cview_setup	View setup information.

---

event

Field

Invoked every time a game event fires.

We do not listen to every single event that exists in the game. If you need something that we don't listen to, please use mods.events

Arguments

Name	Type	Description
event	game_event_t	Game event.

---

handle_input

Field

Invoked every time the game processes mouse/controller input. This is a good place to alter mouse movement, if needed.

Arguments

Name	Type	Description
type	input_type_t	Type of the input.
value	ref_holder_t<float>	Input value.

---

input

Field

Invoked every time the GUI processes input.

Arguments

Name	Type	Description
msg	int	System message. Documentation
w	int	WPARAM.
l	int	LPARAM.