Photon Bolt Engine API  1.2.7
Static Public Member Functions | Properties | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
Bolt.Command Class Reference

Base class that all commands inherit from More...

Inheritance diagram for Bolt.Command:

Static Public Member Functions

static implicit operator bool (Command cmd)
 

Properties

internal bool AssignedInputDeltaCompression [get, private set]
 
internal bool AssignedResultDeltaCompression [get, private set]
 
internal NetworkCommand_Data InputObject [get]
 
bool IsFirstExecution [get]
 Returns true if it's the first time this command executed More...
 
object IBoltListNode< Command >. list [get, set]
 
Command IBoltListNode< Command >. next [get, set]
 
Command IBoltListNode< Command >. prev [get, set]
 
internal NetworkCommand_Data ResultObject [get]
 
int ServerFrame [get, set]
 The value of the BoltNetwork.serverFrame property of the computer this command was created on More...
 
internal bool ShouldDeltaCompressInput [get, set]
 
internal bool ShouldDeltaCompressResult [get, set]
 
internal override NetworkStorage Storage [get]
 
object UserToken [get, set]
 User assignable token that lets you pair arbitrary data with the command, this is not replicated over the network to any remote computers. More...
 

Private Member Functions

internal void BeginSmoothing ()
 
internal Command (Command_Meta meta)
 
internal void Free ()
 
internal int GetDiffDistance (NetworkCommand_Data data, NetworkStorage other)
 
internal void InitNetworkStorage ()
 
internal void PackInput (BoltConnection connection, UdpPacket packet)
 
internal void PackInputDiff (BoltConnection connection, UdpPacket packet, NetworkStorage other)
 
internal void PackResult (BoltConnection connection, UdpPacket packet)
 
internal void PackResultDiff (BoltConnection connection, UdpPacket packet, NetworkStorage other)
 
internal void ReadInput (BoltConnection connection, UdpPacket packet)
 
internal void ReadInputDiff (BoltConnection connection, UdpPacket packet, NetworkStorage other)
 
internal void ReadResult (BoltConnection connection, UdpPacket packet)
 
internal void ReadResultDiff (BoltConnection connection, UdpPacket packet, NetworkStorage other)
 
internal void SmoothCorrection ()
 
internal void VerifyCanSetInput ()
 
internal void VerifyCanSetResult ()
 

Static Private Member Functions

static void PackDiff (BoltConnection connection, UdpPacket packet, NetworkCommand_Data data, NetworkStorage storage, NetworkStorage other)
 
static void ReadDiff (BoltConnection connection, UdpPacket packet, NetworkCommand_Data data, NetworkStorage storage, NetworkStorage smoothStorage, NetworkStorage other)
 

Private Attributes

internal CommandFlags Flags
 
internal new Command_Meta Meta
 
internal const int SEQ_BITS = 8
 
internal const int SEQ_MASK = (1 << SEQ_BITS) - 1
 
internal const int SEQ_SHIFT = 16 - SEQ_BITS
 
internal ushort Sequence
 
bool shouldDeltaCompressInput = false
 
bool shouldDeltaCompressResult = false
 
internal int SmoothFrameFrom
 
internal int SmoothFrameTo
 
internal NetworkStorage SmoothStorageFrom
 
internal NetworkStorage SmoothStorageTo
 
NetworkStorage storage
 

Detailed Description

Base class that all commands inherit from

Constructor & Destructor Documentation

◆ Command()

internal Bolt.Command.Command ( Command_Meta  meta)
inlineprivate

Member Function Documentation

◆ BeginSmoothing()

internal void Bolt.Command.BeginSmoothing ( )
inlineprivate

◆ Free()

internal void Bolt.Command.Free ( )
inlineprivate

◆ GetDiffDistance()

internal int Bolt.Command.GetDiffDistance ( NetworkCommand_Data  data,
NetworkStorage  other 
)
inlineprivate

◆ InitNetworkStorage()

internal void Bolt.Command.InitNetworkStorage ( )
inlineprivate

◆ operator bool()

static implicit Bolt.Command.operator bool ( Command  cmd)
inlinestatic

◆ PackDiff()

static void Bolt.Command.PackDiff ( BoltConnection  connection,
UdpPacket  packet,
NetworkCommand_Data  data,
NetworkStorage  storage,
NetworkStorage  other 
)
inlinestaticprivate

◆ PackInput()

internal void Bolt.Command.PackInput ( BoltConnection  connection,
UdpPacket  packet 
)
inlineprivate

◆ PackInputDiff()

internal void Bolt.Command.PackInputDiff ( BoltConnection  connection,
UdpPacket  packet,
NetworkStorage  other 
)
inlineprivate

◆ PackResult()

internal void Bolt.Command.PackResult ( BoltConnection  connection,
UdpPacket  packet 
)
inlineprivate

◆ PackResultDiff()

internal void Bolt.Command.PackResultDiff ( BoltConnection  connection,
UdpPacket  packet,
NetworkStorage  other 
)
inlineprivate

◆ ReadDiff()

static void Bolt.Command.ReadDiff ( BoltConnection  connection,
UdpPacket  packet,
NetworkCommand_Data  data,
NetworkStorage  storage,
NetworkStorage  smoothStorage,
NetworkStorage  other 
)
inlinestaticprivate

◆ ReadInput()

internal void Bolt.Command.ReadInput ( BoltConnection  connection,
UdpPacket  packet 
)
inlineprivate

◆ ReadInputDiff()

internal void Bolt.Command.ReadInputDiff ( BoltConnection  connection,
UdpPacket  packet,
NetworkStorage  other 
)
inlineprivate

◆ ReadResult()

internal void Bolt.Command.ReadResult ( BoltConnection  connection,
UdpPacket  packet 
)
inlineprivate

◆ ReadResultDiff()

internal void Bolt.Command.ReadResultDiff ( BoltConnection  connection,
UdpPacket  packet,
NetworkStorage  other 
)
inlineprivate

◆ SmoothCorrection()

internal void Bolt.Command.SmoothCorrection ( )
inlineprivate

◆ VerifyCanSetInput()

internal void Bolt.Command.VerifyCanSetInput ( )
inlineprivate

◆ VerifyCanSetResult()

internal void Bolt.Command.VerifyCanSetResult ( )
inlineprivate

Member Data Documentation

◆ Flags

internal CommandFlags Bolt.Command.Flags
private

◆ Meta

internal new Command_Meta Bolt.Command.Meta
private

◆ SEQ_BITS

internal const int Bolt.Command.SEQ_BITS = 8
private

◆ SEQ_MASK

internal const int Bolt.Command.SEQ_MASK = (1 << SEQ_BITS) - 1
private

◆ SEQ_SHIFT

internal const int Bolt.Command.SEQ_SHIFT = 16 - SEQ_BITS
private

◆ Sequence

internal ushort Bolt.Command.Sequence
private

◆ shouldDeltaCompressInput

bool Bolt.Command.shouldDeltaCompressInput = false
private

◆ shouldDeltaCompressResult

bool Bolt.Command.shouldDeltaCompressResult = false
private

◆ SmoothFrameFrom

internal int Bolt.Command.SmoothFrameFrom
private

◆ SmoothFrameTo

internal int Bolt.Command.SmoothFrameTo
private

◆ SmoothStorageFrom

internal NetworkStorage Bolt.Command.SmoothStorageFrom
private

◆ SmoothStorageTo

internal NetworkStorage Bolt.Command.SmoothStorageTo
private

◆ storage

NetworkStorage Bolt.Command.storage
private

Property Documentation

◆ AssignedInputDeltaCompression

internal bool Bolt.Command.AssignedInputDeltaCompression
getprivate setprivate

◆ AssignedResultDeltaCompression

internal bool Bolt.Command.AssignedResultDeltaCompression
getprivate setprivate

◆ InputObject

internal NetworkCommand_Data Bolt.Command.InputObject
getprivate

◆ IsFirstExecution

bool Bolt.Command.IsFirstExecution
get

Returns true if it's the first time this command executed

◆ list

object IBoltListNode<Command>. Bolt.Command.list
getsetprivate

◆ next

Command IBoltListNode<Command>. Bolt.Command.next
getsetprivate

◆ prev

Command IBoltListNode<Command>. Bolt.Command.prev
getsetprivate

◆ ResultObject

internal NetworkCommand_Data Bolt.Command.ResultObject
getprivate

◆ ServerFrame

int Bolt.Command.ServerFrame
getset

The value of the BoltNetwork.serverFrame property of the computer this command was created on

◆ ShouldDeltaCompressInput

internal bool Bolt.Command.ShouldDeltaCompressInput
getsetprivate

◆ ShouldDeltaCompressResult

internal bool Bolt.Command.ShouldDeltaCompressResult
getsetprivate

◆ Storage

internal override NetworkStorage Bolt.Command.Storage
getprivate

◆ UserToken

object Bolt.Command.UserToken
getset

User assignable token that lets you pair arbitrary data with the command, this is not replicated over the network to any remote computers.