Package GameAPI

Namespaces
package	BudgetBoy
package	Internal
package	Sandboxing

Classes
class	APIAssemblyNotFoundException
	Exception thrown when a game platform API assembly is referenced that could not be found. More...
struct	AStarEdge< T >
	Represents a connection on a graph, for use with AStar(). More...
class	AudioBase< TGame, TImplementation >
	Base class for audio hardware interfaces. More...
class	AudioChannelBase
class	AudioChannelProxy
class	Axis
	Represents a single analogue axis. More...
class	Axis2
	Represents two orthogonal analogue axes. More...
class	AxisHandle
class	Button
	Represents a single discrete button. More...
class	ButtonHandle
struct	Color24
	Structure representing a 24-bit RGB color (8 bits per component). More...
class	Control
	Base class for any device providing game input. More...
class	ControlHandle
class	ControlsBase< TGame, TImplementation >
	Base class for controls hardware interfaces. More...
class	Debug
	Provides tools for developers to diagnose issues with their games. More...
class	Demo
	Contains a recording of an arcade game as a sequence of frames. More...
class	Ease
class	FirmwareBase< TGame, TImplementation >
class	FrameStream
	Represents a subsection of another stream, starting from a certain offset and with a given length. More...
class	GameBase
	Base class for all arcade games. More...
class	GameBase< TControls, TGraphics, TAudio, TFirmware >
	Base class for all arcade games, specifying a particular controls, graphics and audio (virtual) hardware implementation. More...
class	GameInfoAttribute
	Class-level attribute to provide information about an arcade game. More...
class	GraphicsBase< TGame, TImplementation >
	Base class for graphics hardware interfaces. More...
class	GraphicsInfoAttribute
	Class-level attribute to provide information about the graphical specifications of an arcade game. More...
class	Highscore
	Represents a score attained by a player in an arcade game. More...
class	HighscoreExtensions
class	HighscoreSubmittedEventArgs
	Provides information for events called when a Highscore is submitted. More...
interface	IAudio
interface	IAudioInternal
interface	IControls
interface	IControlsInternal
interface	IFirmware
interface	IGame
interface	IGameInfo
	Interface for types that provide information about an arcade game. More...
interface	IGraphics
interface	IGraphicsInfo
	Interface for types that provide information about the graphical specifications of an arcade game. More...
interface	IGraphicsInternal
class	InfoExtensions
interface	IPeripheral
interface	ISound
class	Mathf
	Provides constants and static methods for floating point mathematics. More...
class	NetMessage
class	Peripheral
class	Peripheral< TGame, TProvider, TImplementation >
	Base class for hardware input and output devices. More...
struct	RectF
	An axis-aligned rectangle, using single precision floating-point numbers for each component. More...
struct	RectI
	An axis-aligned rectangle, using signed integers for each component. More...
class	ResourceManager
	Class containing methods for registering and listing resource types. More...
class	Resources
	Class containing methods related to accessing resources. More...
class	SoundEventArgs
class	StreamedSoundEventArgs
class	Tools
	Provides some helpful methods that don't belong anywhere else. More...
struct	Transform
	Structure representing a 2D affine transformation. More...
struct	Vector2F
	A two component vector of floats. More...
struct	Vector2I
	A two component vector of integers. More...

Enumerations
enum	NetSendMethod : byte { NetSendMethod.UnreliableUnordered = 0, NetSendMethod.UnreliableOrdered = 1, NetSendMethod.ReliableUnordered = 2, NetSendMethod.ReliableOrdered = 3 }
enum	ResourceFormat { ResourceFormat.Default = ResourceLibrary.ResourceFormat.Default, ResourceFormat.Compressed = ResourceLibrary.ResourceFormat.Compressed }
	Describes whether resources should be compressed when packaged. More...

Functions
delegate void	MessageDelegate (object value)
	Delegate used for Debug message events. More...
delegate float	EasingFunction (float t, float a=0f, float b=1f)
delegate void	SaveResourceDelegate< in T > (Stream stream, T resource)
	Delegate used to write a resource of type T to a stream. More...
delegate T	LoadResourceDelegate< out T > (Stream stream, string extension)
	Delegate used to read a resource of type T from a stream. More...

Enumeration Type Documentation

enum GameAPI.NetSendMethod : byte

Enumerator
UnreliableUnordered
UnreliableOrdered
ReliableUnordered
ReliableOrdered

enum GameAPI.ResourceFormat

Describes whether resources should be compressed when packaged.

Enumerator
Default	Resource should be packaged without compression.
Compressed	Resource should be compressed when packaged.

Function Documentation

delegate float GameAPI.EasingFunction	(	float	t,
		float	a = 0f,
		float	b = 1f
	)

delegate T GameAPI.LoadResourceDelegate< out T >	(	Stream	stream,
		string	extension
	)

Delegate used to read a resource of type T from a stream.

Template Parameters

T	Resource type to read.

Parameters

stream	Stream to read the resource from.
extension	If reading from a file, the file extension. Otherwise, null.

delegate void GameAPI.MessageDelegate

(

object

value

)

Delegate used for Debug message events.

Parameters

value

The message received.

delegate void GameAPI.SaveResourceDelegate< in T >	(	Stream	stream,
		T	resource
	)

Delegate used to write a resource of type T to a stream.

Template Parameters

T	Resource type to write.

Parameters

stream	Stream to write the resource to.
resource	Resource to write to a stream.