C# Class OpenBveApi.Hosts.HostInterface

Represents the host application and functionality it exposes.

Public Methods

Method	Description
LoadObject ( string path, AbstractObject &obj ) : bool	Loads an object and returns the object data.
LoadSound ( string path, Sounds &sound ) : bool	Loads a sound and returns the sound data.
LoadTexture ( string path, TextureParameters parameters, Textures &texture ) : bool	Loads a texture and returns the texture data.
QueryTextureDimensions ( string path, int &width, int &height ) : bool	Queries the dimensions of a texture.
RegisterSound ( Sounds sound, SoundHandle &handle ) : bool	Registers a sound and returns a handle to the sound.
RegisterSound ( string path, SoundHandle &handle ) : bool	Registers a sound and returns a handle to the sound.
RegisterTexture ( Textures texture, TextureParameters parameters, TextureHandle &handle ) : bool	Registers a texture and returns a handle to the texture.
RegisterTexture ( string path, TextureParameters parameters, TextureHandle &handle ) : bool	Registers a texture and returns a handle to the texture.
ReportProblem ( ProblemType type, string text ) : void	Reports a problem to the host application.

Loads an object and returns the object data.

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

Loads a sound and returns the sound data.

public LoadSound ( string path, Sounds &sound ) : bool
path	string	The path to the file or folder that contains the sound.
sound	Sounds	Receives the sound.
return	bool

Loads a texture and returns the texture data.

public LoadTexture ( string path, TextureParameters parameters, Textures &texture ) : bool
path	string	The path to the file or folder that contains the texture.
parameters	OpenBveApi.Textures.TextureParameters	The parameters that specify how to process the texture.
texture	Textures	Receives the texture.
return	bool

Queries the dimensions of a texture.

public QueryTextureDimensions ( string path, int &width, int &height ) : bool
path	string	The path to the file or folder that contains the texture.
width	int	Receives the width of the texture.
height	int	Receives the height of the texture.
return	bool

Registers a sound and returns a handle to the sound.

public RegisterSound ( Sounds sound, SoundHandle &handle ) : bool
sound	Sounds	The sound data.
handle	SoundHandle	Receives a handle to the sound.
return	bool

Registers a sound and returns a handle to the sound.

public RegisterSound ( string path, SoundHandle &handle ) : bool
path	string	The path to the file or folder that contains the sound.
handle	SoundHandle	Receives a handle to the sound.
return	bool

Registers a texture and returns a handle to the texture.

public RegisterTexture ( Textures texture, TextureParameters parameters, TextureHandle &handle ) : bool
texture	Textures	The texture data.
parameters	OpenBveApi.Textures.TextureParameters	The parameters that specify how to process the texture.
handle	TextureHandle	Receives the handle to the texture.
return	bool

Registers a texture and returns a handle to the texture.

public RegisterTexture ( string path, TextureParameters parameters, TextureHandle &handle ) : bool
path	string	The path to the file or folder that contains the texture.
parameters	OpenBveApi.Textures.TextureParameters	The parameters that specify how to process the texture.
handle	TextureHandle	Receives the handle to the texture.
return	bool

Reports a problem to the host application.

public ReportProblem ( ProblemType type, string text ) : void
type	ProblemType	The type of problem that is reported.
text	string	The textual message that describes the problem.
return	void