C# Class OpenBveApi.Objects.ObjectInterface

Represents the interface for loading objects. Plugins must implement this interface if they wish to expose objects.
ファイルを表示 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.

Method Details

CanLoadObject() public abstract method

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

Load() public method

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

LoadObject() public abstract method

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

Unload() public method

Called when the plugin is unloaded.
public Unload ( ) : void
return void