C# Class OpenBveApi.Objects.ObjectInterface

Represents the interface for loading objects. Plugins must implement this interface if they wish to expose objects.

Mostra file Open project: leezer3/OpenBVE

Public Methods

Method	Description
CanLoadObject ( string path ) : bool	Checks whether the plugin can load the specified object.
Load ( Hosts host ) : void	Called when the plugin is loaded.
LoadObject ( string path, Object &obj ) : bool	Loads the specified object.
Unload ( ) : void	Called when the plugin is unloaded.

Checks whether the plugin can load the specified object.

public abstract CanLoadObject ( string path ) : bool
path	string	The path to the file or folder that contains the object.
return	bool

Called when the plugin is loaded.

public Load ( Hosts host ) : void
host	Hosts	The host that loaded the plugin.
return	void

Loads the specified object.

public abstract LoadObject ( string path, Object &obj ) : bool
path	string	The path to the file or folder that contains the object.
obj	Object	Receives the object.
return	bool

Called when the plugin is unloaded.

public Unload ( ) : void
return	void