Struct CustomPlugin

pub struct CustomPlugin { /* private fields */ }

A plugin definition

Implementations

impl CustomPlugin

pub fn new(id: &str) -> Result<Self>

Create a new plugin definition

pub fn with_settings(id: &str, settings: PluginSettings) -> Result<Self>

Create a new plugin definition with more advanced settings

pub fn from_manifest_file(id: &str, manifest: &str) -> Result<Self>

Create a new plugin definition from manifest file contents

pub fn from_manifest(id: &str, manifest: &PluginManifest) -> Result<Self>

Create a new plugin definition from a manifest

pub fn get_id(&self) -> &str

Get the ID of the plugin

pub fn on_load( &mut self, f: impl FnOnce(HookContext<'_, OnLoad>, <OnLoad as Hook>::Arg) -> Result<<OnLoad as Hook>::Result>, ) -> Result<()>

Bind to the subcommand hook Bind to the on_load hook

pub fn subcommand( &mut self, f: impl FnOnce(HookContext<'_, Subcommand>, <Subcommand as Hook>::Arg) -> Result<<Subcommand as Hook>::Result>, ) -> Result<()>

Bind to the subcommand hook Bind to the subcommand hook

pub fn modify_instance_config( &mut self, f: impl FnOnce(HookContext<'_, ModifyInstanceConfig>, <ModifyInstanceConfig as Hook>::Arg) -> Result<<ModifyInstanceConfig as Hook>::Result>, ) -> Result<()>

Bind to the subcommand hook Bind to the modify_instance_config hook

pub fn add_versions( &mut self, f: impl FnOnce(HookContext<'_, AddVersions>, <AddVersions as Hook>::Arg) -> Result<<AddVersions as Hook>::Result>, ) -> Result<()>

Bind to the subcommand hook Bind to the add_versions hook

pub fn on_instance_setup( &mut self, f: impl FnOnce(HookContext<'_, OnInstanceSetup>, <OnInstanceSetup as Hook>::Arg) -> Result<<OnInstanceSetup as Hook>::Result>, ) -> Result<()>

Bind to the subcommand hook Bind to the on_instance_setup hook

pub fn on_instance_launch( &mut self, f: impl FnOnce(HookContext<'_, OnInstanceLaunch>, <OnInstanceLaunch as Hook>::Arg) -> Result<<OnInstanceLaunch as Hook>::Result>, ) -> Result<()>

Bind to the subcommand hook Bind to the on_instance_launch hook

pub fn while_instance_launch( &mut self, f: impl FnOnce(HookContext<'_, WhileInstanceLaunch>, <WhileInstanceLaunch as Hook>::Arg) -> Result<<WhileInstanceLaunch as Hook>::Result>, ) -> Result<()>

Bind to the subcommand hook Bind to the while_instance_launch hook

pub fn on_instance_stop( &mut self, f: impl FnOnce(HookContext<'_, OnInstanceStop>, <OnInstanceStop as Hook>::Arg) -> Result<<OnInstanceStop as Hook>::Result>, ) -> Result<()>

Bind to the subcommand hook Bind to the on_instance_stop hook

pub fn custom_package_instruction( &mut self, f: impl FnOnce(HookContext<'_, CustomPackageInstruction>, <CustomPackageInstruction as Hook>::Arg) -> Result<<CustomPackageInstruction as Hook>::Result>, ) -> Result<()>

Bind to the subcommand hook Bind to the custom_package_instruction hook

pub fn handle_auth( &mut self, f: impl FnOnce(HookContext<'_, HandleAuth>, <HandleAuth as Hook>::Arg) -> Result<<HandleAuth as Hook>::Result>, ) -> Result<()>

Bind to the subcommand hook Bind to the handle_auth hook

pub fn add_translations( &mut self, f: impl FnOnce(HookContext<'_, AddTranslations>, <AddTranslations as Hook>::Arg) -> Result<<AddTranslations as Hook>::Result>, ) -> Result<()>

Bind to the subcommand hook Bind to the add_translations hook

pub fn add_instance_transfer_formats( &mut self, f: impl FnOnce(HookContext<'_, AddInstanceTransferFormats>, <AddInstanceTransferFormats as Hook>::Arg) -> Result<<AddInstanceTransferFormats as Hook>::Result>, ) -> Result<()>

Bind to the subcommand hook Bind to the add_instance_transfer_formats hook

pub fn export_instance( &mut self, f: impl FnOnce(HookContext<'_, ExportInstance>, <ExportInstance as Hook>::Arg) -> Result<<ExportInstance as Hook>::Result>, ) -> Result<()>

Bind to the subcommand hook Bind to the export_instance hook

pub fn import_instance( &mut self, f: impl FnOnce(HookContext<'_, ImportInstance>, <ImportInstance as Hook>::Arg) -> Result<<ImportInstance as Hook>::Result>, ) -> Result<()>

Bind to the subcommand hook Bind to the import_instance hook

pub fn add_supported_game_modifications( &mut self, f: impl FnOnce(HookContext<'_, AddSupportedGameModifications>, <AddSupportedGameModifications as Hook>::Arg) -> Result<<AddSupportedGameModifications as Hook>::Result>, ) -> Result<()>

Bind to the subcommand hook Bind to the add_supported_game_modifications hook