yaze_extension Struct Reference

Extension interface for Yaze. More...

#include <extension.h>

Collaboration diagram for yaze_extension:

Public Attributes
const char *	name
const char *	version
yaze_initialize_func	initialize
	Function to initialize the extension.
yaze_cleanup_func	cleanup
	Function to clean up the extension.
yaze_manipulate_rom_func	manipulate_rom
	Function to manipulate the ROM.
yaze_extend_ui_func	extend_ui
	Function to extend the UI.
yaze_command_func	register_commands
	Register commands in the yaze_command_registry.
yaze_command_func	register_custom_tools
	Register custom tools in the yaze_command_registry.
void(*	register_event_hooks )(yaze_event_type event, yaze_event_hook_func hook)
	Register event hooks in the yaze_event_dispatcher.

Detailed Description

Extension interface for Yaze.

Yaze extensions can be written in C or Python.

Definition at line 29 of file extension.h.

Member Data Documentation

name

const char* yaze_extension::name

Definition at line 30 of file extension.h.

Referenced by BOOST_PYTHON_MODULE().

version

const char* yaze_extension::version

Definition at line 31 of file extension.h.

Referenced by BOOST_PYTHON_MODULE().

initialize

yaze_initialize_func yaze_extension::initialize

Function to initialize the extension.

This function is called when the extension is loaded. It can be used to set up any resources or state needed by the extension.

Definition at line 39 of file extension.h.

Referenced by yaze::app::editor::ExtensionManager::LoadExtension().

cleanup

yaze_cleanup_func yaze_extension::cleanup

Function to clean up the extension.

This function is called when the extension is unloaded. It can be used to clean up any resources or state used by the extension.

Definition at line 47 of file extension.h.

manipulate_rom

yaze_manipulate_rom_func yaze_extension::manipulate_rom

Function to manipulate the ROM.

Parameters

rom	The ROM to manipulate.

Definition at line 55 of file extension.h.

extend_ui

yaze_extend_ui_func yaze_extension::extend_ui

Function to extend the UI.

Parameters

context

The editor context.

This function is called when the extension is loaded. It can be used to add custom UI elements to the editor. The context parameter provides access to the project, command registry, event dispatcher, and ImGui context.

Definition at line 67 of file extension.h.

register_commands

yaze_command_func yaze_extension::register_commands

Register commands in the yaze_command_registry.

Definition at line 72 of file extension.h.

register_custom_tools

yaze_command_func yaze_extension::register_custom_tools

Register custom tools in the yaze_command_registry.

Definition at line 77 of file extension.h.

register_event_hooks

void(* yaze_extension::register_event_hooks) (yaze_event_type event, yaze_event_hook_func hook)

Register event hooks in the yaze_event_dispatcher.

Definition at line 82 of file extension.h.

---

The documentation for this struct was generated from the following file:

• src/incl/extension.h