plugin

README

plugin

Plugin interface definitions that enable extension of the Launchrail simulation with custom functionality.

Notes

• Defines standard interfaces for simulation plugins
• Provides API contracts for plugin developers
• Enables modular extension of simulation capabilities
• Supports runtime loading of plugin functionality
• Includes safety mechanisms for plugin execution
• Defines clear boundaries between core and plugin code
• Facilitates plugin discovery and registration processes
• Ensures version compatibility between plugins and core

Documentation

Index

• type SimulationPlugin

Types

type SimulationPlugin

type SimulationPlugin interface {
	// Initialize is called when the plugin is loaded
	Initialize(log logf.Logger, cfg *config.Config) error

	// Name returns the unique identifier of the plugin
	Name() string

	// Version returns the plugin version
	Version() string

	// BeforeSimStep is called before each simulation step
	BeforeSimStep(state *states.PhysicsState) error

	// AfterSimStep is called after each simulation step
	AfterSimStep(state *states.PhysicsState) error

	// Cleanup is called when the simulation ends
	Cleanup() error
}

SimulationPlugin defines the interface that all plugins must implement