Table of Contents

Class Definition

Namespace
Coherence.Generated
Assembly
Coherence.Common.Tests.dll
public class Definition : IDefinition, ISchemaSpecificComponentDeserialize, ISchemaSpecificComponentSerialize, IAuthorityManagement, IBuiltInComponentAccess, IComponentInfo
Inheritance
Definition
Implements

Constructors

Definition()

public Definition()

Fields

CommandRoutingByType

public static readonly Dictionary<uint, MessageTarget> CommandRoutingByType

Field Value

Dictionary<uint, MessageTarget>

InternalAdoptOrphan

public const uint InternalAdoptOrphan = 3

Field Value

uint

InternalArchetypeComponent

public const uint InternalArchetypeComponent = 4

Field Value

uint

InternalAuthorityRequest

public const uint InternalAuthorityRequest = 0

Field Value

uint

InternalAuthorityTransfer

public const uint InternalAuthorityTransfer = 1

Field Value

uint

InternalBoolInput

public const uint InternalBoolInput = 0

Field Value

uint

InternalByteArrayTest

public const uint InternalByteArrayTest = 16

Field Value

uint

InternalCompressedInput

public const uint InternalCompressedInput = 8

Field Value

uint

InternalConnectedEntity

public const uint InternalConnectedEntity = 6

Field Value

uint

InternalConnection

public const uint InternalConnection = 8

Field Value

uint

InternalConnectionScene

public const uint InternalConnectionScene = 9

Field Value

uint

InternalFloatComponent

public const uint InternalFloatComponent = 18

Field Value

uint

InternalFloatInput

public const uint InternalFloatInput = 2

Field Value

uint

InternalGlobal

public const uint InternalGlobal = 10

Field Value

uint

InternalGlobalQuery

public const uint InternalGlobalQuery = 11

Field Value

uint

InternalIntComponent

public const uint InternalIntComponent = 17

Field Value

uint

InternalIntInput

public const uint InternalIntInput = 1

Field Value

uint

InternalLocalUserComponent

public const uint InternalLocalUserComponent = 2

Field Value

uint

InternalMultiComponent

public const uint InternalMultiComponent = 20

Field Value

uint

InternalMultiInput

public const uint InternalMultiInput = 7

Field Value

uint

InternalOrderedComp

public const uint InternalOrderedComp = 19

Field Value

uint

InternalPersistence

public const uint InternalPersistence = 5

Field Value

uint

InternalPersistenceReady

public const uint InternalPersistenceReady = 4

Field Value

uint

InternalPreserveChildren

public const uint InternalPreserveChildren = 14

Field Value

uint

InternalQuaternionInput

public const uint InternalQuaternionInput = 3

Field Value

uint

InternalQuerySynced

public const uint InternalQuerySynced = 2

Field Value

uint

InternalScene

public const uint InternalScene = 15

Field Value

uint

InternalSceneIndexChanged

public const uint InternalSceneIndexChanged = 5

Field Value

uint

InternalSimFramesComponent

public const uint InternalSimFramesComponent = 21

Field Value

uint

InternalStringInput

public const uint InternalStringInput = 6

Field Value

uint

InternalTag

public const uint InternalTag = 12

Field Value

uint

InternalTagQuery

public const uint InternalTagQuery = 13

Field Value

uint

InternalUniqueID

public const uint InternalUniqueID = 7

Field Value

uint

InternalVector2Input

public const uint InternalVector2Input = 4

Field Value

uint

InternalVector3Input

public const uint InternalVector3Input = 5

Field Value

uint

InternalWorldOrientation

public const uint InternalWorldOrientation = 1

Field Value

uint

InternalWorldPosition

public const uint InternalWorldPosition = 0

Field Value

uint

InternalWorldPositionQuery

public const uint InternalWorldPositionQuery = 3

Field Value

uint

schemaId

public const string schemaId = "6157c5569fcbf925bf9ae31fb190e09ff5bd6961"

Field Value

string

Methods

ComponentNameForTypeId(uint)

public static string ComponentNameForTypeId(uint typeId)

Parameters

typeId uint

Returns

string

CreateAdoptOrphanCommand()

public IEntityCommand CreateAdoptOrphanCommand()

Returns

IEntityCommand

CreateAuthorityRequest(Entity, ClientID, AuthorityType)

public IEntityCommand CreateAuthorityRequest(Entity entity, ClientID requester, AuthorityType authType)

Parameters

entity Entity
requester ClientID
authType AuthorityType

Returns

IEntityCommand

CreateAuthorityTransfer(Entity, ClientID, bool, AuthorityType)

public IEntityCommand CreateAuthorityTransfer(Entity entity, ClientID newAuthority, bool accepted, AuthorityType authType)

Parameters

entity Entity
newAuthority ClientID
accepted bool
authType AuthorityType

Returns

IEntityCommand

CreateSceneIndexChangedCommand(Entity, int)

public IEntityCommand CreateSceneIndexChangedCommand(Entity entity, int sceneIndex)

Parameters

entity Entity
sceneIndex int

Returns

IEntityCommand

ExtractCoherenceTag(ICoherenceComponentData)

public string ExtractCoherenceTag(ICoherenceComponentData data)

Parameters

data ICoherenceComponentData

Returns

string

ExtractCoherenceUUID(ICoherenceComponentData)

public string ExtractCoherenceUUID(ICoherenceComponentData data)

Parameters

data ICoherenceComponentData

Returns

string

ExtractConnectedEntityID(ICoherenceComponentData)

public Entity ExtractConnectedEntityID(ICoherenceComponentData data)

Parameters

data ICoherenceComponentData

Returns

Entity

GenerateCoherenceUUIDData(string, AbsoluteSimulationFrame)

public ICoherenceComponentData GenerateCoherenceUUIDData(string uuid, AbsoluteSimulationFrame simFrame)

Parameters

uuid string
simFrame AbsoluteSimulationFrame

Returns

ICoherenceComponentData

GenerateGlobalQueryComponent()

public ICoherenceComponentData GenerateGlobalQueryComponent()

Returns

ICoherenceComponentData

GeneratePersistenceData()

public ICoherenceComponentData GeneratePersistenceData()

Returns

ICoherenceComponentData

IsConnectedEntity(ICoherenceComponentData)

public bool IsConnectedEntity(ICoherenceComponentData data)

Parameters

data ICoherenceComponentData

Returns

bool

IsSendOrderedComponent(uint)

public bool IsSendOrderedComponent(uint componentID)

Parameters

componentID uint

Returns

bool

ReadCommands(IInBitStream, Logger)

public IEntityCommand[] ReadCommands(IInBitStream bitStream, Logger logger)

Parameters

bitStream IInBitStream
logger Logger

Returns

IEntityCommand[]

ReadComponentUpdate(uint, AbsoluteSimulationFrame, IInBitStream, Logger)

public ICoherenceComponentData ReadComponentUpdate(uint componentType, AbsoluteSimulationFrame referenceSimulationFrame, IInBitStream bitStream, Logger logger)

Parameters

componentType uint
referenceSimulationFrame AbsoluteSimulationFrame
bitStream IInBitStream
logger Logger

Returns

ICoherenceComponentData

ReadInputs(IInBitStream, Logger)

public IEntityInput[] ReadInputs(IInBitStream bitStream, Logger logger)

Parameters

bitStream IInBitStream
logger Logger

Returns

IEntityInput[]

TryGetAuthorityRequestCommand(IEntityCommand, out ClientID, out AuthorityType)

public bool TryGetAuthorityRequestCommand(IEntityCommand entityCommand, out ClientID requester, out AuthorityType authType)

Parameters

entityCommand IEntityCommand
requester ClientID
authType AuthorityType

Returns

bool

TryGetAuthorityTransferCommand(IEntityCommand, out ClientID, out bool, out AuthorityType)

public bool TryGetAuthorityTransferCommand(IEntityCommand entityCommand, out ClientID newAuthority, out bool transferAccepted, out AuthorityType authType)

Parameters

entityCommand IEntityCommand
newAuthority ClientID
transferAccepted bool
authType AuthorityType

Returns

bool

TryGetSceneIndexChangedCommand(IEntityCommand, out int)

public bool TryGetSceneIndexChangedCommand(IEntityCommand entityCommand, out int sceneIndex)

Parameters

entityCommand IEntityCommand
sceneIndex int

Returns

bool

WriteCommand(IEntityCommand, uint, IOutProtocolBitStream, Logger)

public void WriteCommand(IEntityCommand data, uint commandType, IOutProtocolBitStream bitStream, Logger logger)

Parameters

data IEntityCommand
commandType uint
bitStream IOutProtocolBitStream
logger Logger

WriteComponentUpdate(ICoherenceComponentData, uint, bool, AbsoluteSimulationFrame, IOutProtocolBitStream, Logger)

public uint WriteComponentUpdate(ICoherenceComponentData data, uint serializeAs, bool isRefSimFrameValid, AbsoluteSimulationFrame referenceSimulationFrame, IOutProtocolBitStream protocolStream, Logger logger)

Parameters

data ICoherenceComponentData
serializeAs uint
isRefSimFrameValid bool
referenceSimulationFrame AbsoluteSimulationFrame
protocolStream IOutProtocolBitStream
logger Logger

Returns

uint

WriteInput(IEntityInput, uint, IOutProtocolBitStream, Logger)

public void WriteInput(IEntityInput data, uint inputType, IOutProtocolBitStream bitStream, Logger logger)

Parameters

data IEntityInput
inputType uint
bitStream IOutProtocolBitStream
logger Logger