Photon Quantum 3.0.0

Public Member Functions | Public Attributes | Static Public Attributes | Properties | List of all members
Quantum.CallbackPollInput Class Reference

Callback called when the simulation queries local input. More...

Inheritance diagram for Quantum.CallbackPollInput:
Quantum.QuantumGame.CallbackBase Quantum.CallbackBase Quantum.IDispatchable

Public Member Functions

void SetInput (Input input, DeterministicInputFlags flags)
 Set the polled input result. More...
 
void SetInput (QTuple< Input, DeterministicInputFlags > input)
 Set the polled input result. More...
 
- Public Member Functions inherited from Quantum.QuantumGame.CallbackBase
 CallbackBase (int id, QuantumGame game)
 Constructor. More...
 
- Public Member Functions inherited from Quantum.CallbackBase
 CallbackBase (int id)
 Create the callback with an id. More...
 
 CallbackBase (int id, IDeterministicGame game)
 Creates a callback with an id and a game. More...
 

Public Attributes

Int32 Frame
 The frame number the input is polled for. More...
 
Int32 PlayerSlot
 The local player slot the input is polled for (this is not the global player number). More...
 
- Public Attributes inherited from Quantum.CallbackBase
readonly int ID
 The callback id. More...
 

Static Public Attributes

const new Int32 ID = (int)CallbackId.PollInput
 The const CallbackPollInput id. More...
 

Properties

DeterministicInputFlags Flags [get]
 Access the input flags. Use SetInput(Input, DeterministicInputFlags) to set. More...
 
Input Input [get]
 Access the set input. Use SetInput(Input, DeterministicInputFlags) to set. More...
 
bool IsFirstInThisUpdate [get]
 Is set to true if this is first time ever that input is pulled in this simulation. More...
 
bool IsInputSet [get]
 Will be marked as set after SetInput(Input, DeterministicInputFlags) has been called. More...
 
Int32 Player [get, set]
 Obsolete, renamed to PlayerSlot. More...
 
- Properties inherited from Quantum.QuantumGame.CallbackBase
new QuantumGame Game [get, set]
 The assigned game. More...
 
- Properties inherited from Quantum.CallbackBase
IDeterministicGame Game [get, set]
 The game that the callback is dispatched to. More...
 
- Properties inherited from Quantum.IDispatchable
IDeterministicGame Game [get]
 The game that the callback or event is dispatched to. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Quantum.QuantumGame.CallbackBase
static Type GetCallbackType (CallbackId id)
 Maps the const callback id CallbackId to a callback system type. More...
 

Detailed Description

Callback called when the simulation queries local input.

Member Function Documentation

◆ SetInput() [1/2]

void Quantum.CallbackPollInput.SetInput ( Input  input,
DeterministicInputFlags  flags 
)
inline

Set the polled input result.

Parameters
inputInput object
flagsFlags

◆ SetInput() [2/2]

void Quantum.CallbackPollInput.SetInput ( QTuple< Input, DeterministicInputFlags input)
inline

Set the polled input result.

Parameters
inputInput tuple

Member Data Documentation

◆ ID

const new Int32 Quantum.CallbackPollInput.ID = (int)CallbackId.PollInput
static

The const CallbackPollInput id.

◆ Frame

Int32 Quantum.CallbackPollInput.Frame

The frame number the input is polled for.

◆ PlayerSlot

Int32 Quantum.CallbackPollInput.PlayerSlot

The local player slot the input is polled for (this is not the global player number).

Property Documentation

◆ Player

Int32 Quantum.CallbackPollInput.Player
getset

Obsolete, renamed to PlayerSlot.

◆ IsFirstInThisUpdate

bool Quantum.CallbackPollInput.IsFirstInThisUpdate
get

Is set to true if this is first time ever that input is pulled in this simulation.

◆ IsInputSet

bool Quantum.CallbackPollInput.IsInputSet
get

Will be marked as set after SetInput(Input, DeterministicInputFlags) has been called.

◆ Input

Input Quantum.CallbackPollInput.Input
get

Access the set input. Use SetInput(Input, DeterministicInputFlags) to set.

◆ Flags

DeterministicInputFlags Quantum.CallbackPollInput.Flags
get

Access the input flags. Use SetInput(Input, DeterministicInputFlags) to set.