Arcade
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
GameAPI.ControlsBase< TGame, TImplementation > Class Template Reference

Base class for controls hardware interfaces. More...

Inheritance diagram for GameAPI.ControlsBase< TGame, TImplementation >:
GameAPI.Peripheral< TGame, TProvider, TImplementation > GameAPI.Peripheral GameAPI.BudgetBoy.Controls

Protected Member Functions

override void OnSerializeSetup (Stream stream)
 
override void OnSerializeFrame (Stream stream)
 
override void OnDeserializeFrame (Stream stream)
 
virtual void OnSetCursorVisibility ()
 
Button AddButton (params string[] idents)
 
Axis AddAxis (params string[] idents)
 
Axis2 AddAxis2 (Axis x, Axis y)
 
Axis2 AddCursor (RectF range)
 
override void OnStartControlling ()
 
override void OnStopControlling ()
 
override void OnUpdateFrame (double dt)
 
- Protected Member Functions inherited from GameAPI.Peripheral< TGame, TProvider, TImplementation >
override void OnInitialize ()
 
virtual void OnAttachImplementation ()
 
- Protected Member Functions inherited from GameAPI.Peripheral
void ClearFrameWriter ()
 
virtual void OnRegisterResourceTypes (ResourceManager library)
 
virtual void OnLoadResources (Resources volume)
 
virtual void OnReset ()
 
virtual void OnDeserializeSetup (Stream stream)
 
virtual void OnCopyFrame (Stream stream)
 

Properties

override bool ShouldUpdate [get]
 
bool IsCursorVisible [get, set]
 
- Properties inherited from GameAPI.Peripheral< TGame, TProvider, TImplementation >
virtual bool ShouldUpdate [get]
 
- Properties inherited from GameAPI.Peripheral
BinaryWriter FrameWriter [get]
 

Additional Inherited Members

- Public Member Functions inherited from GameAPI.Peripheral< TGame, TProvider, TImplementation >
override void Dispose ()
 

Detailed Description

Base class for controls hardware interfaces.

Type Constraints
TGame :GameBase 
TImplementation :PeripheralImplementation<ControlsProvider> 
TImplementation :new() 

Member Function Documentation

Axis GameAPI.ControlsBase< TGame, TImplementation >.AddAxis ( params string[]  idents)
inlineprotected
Axis2 GameAPI.ControlsBase< TGame, TImplementation >.AddAxis2 ( Axis  x,
Axis  y 
)
inlineprotected
Button GameAPI.ControlsBase< TGame, TImplementation >.AddButton ( params string[]  idents)
inlineprotected
Axis2 GameAPI.ControlsBase< TGame, TImplementation >.AddCursor ( RectF  range)
inlineprotected
override void GameAPI.ControlsBase< TGame, TImplementation >.OnDeserializeFrame ( Stream  stream)
inlineprotectedvirtual

Reimplemented from GameAPI.Peripheral.

override void GameAPI.ControlsBase< TGame, TImplementation >.OnSerializeFrame ( Stream  stream)
inlineprotectedvirtual

Reimplemented from GameAPI.Peripheral.

override void GameAPI.ControlsBase< TGame, TImplementation >.OnSerializeSetup ( Stream  stream)
inlineprotectedvirtual

Reimplemented from GameAPI.Peripheral.

virtual void GameAPI.ControlsBase< TGame, TImplementation >.OnSetCursorVisibility ( )
inlineprotectedvirtual
override void GameAPI.ControlsBase< TGame, TImplementation >.OnStartControlling ( )
inlineprotectedvirtual

Reimplemented from GameAPI.Peripheral.

override void GameAPI.ControlsBase< TGame, TImplementation >.OnStopControlling ( )
inlineprotectedvirtual

Reimplemented from GameAPI.Peripheral.

override void GameAPI.ControlsBase< TGame, TImplementation >.OnUpdateFrame ( double  dt)
inlineprotectedvirtual

Reimplemented from GameAPI.Peripheral.

Property Documentation

bool GameAPI.ControlsBase< TGame, TImplementation >.IsCursorVisible
getset
override bool GameAPI.ControlsBase< TGame, TImplementation >.ShouldUpdate
getprotected