V1Alpha1.EntityCommandRequest Class

Namespace: Improbable.SpatialOS.RemoteInteraction

If you use the GDK for Unreal version 0.10 or later, this class is not compatible with the Standard Runtime variant. If you want to use this class, you must use the Compatibility Mode Runtime variant.

Inheritance

pb::IMessage<EntityCommandRequest>

Child types

Name
Description

Container for nested types declared in the EntityCommandRequest message type.


Const Fields

TargetFieldNumber
const int TargetFieldNumber = 1

Field number for the "target" field.

WorkerTypeFieldNumber
const int WorkerTypeFieldNumber = 2

Field number for the "worker_type" field.

WorkerIdFieldNumber
const int WorkerIdFieldNumber = 3

Field number for the "worker_id" field.

ComponentTargetFieldNumber
const int ComponentTargetFieldNumber = 4

Field number for the "component_target" field.

BinaryFieldNumber
const int BinaryFieldNumber = 5

Field number for the "binary" field.


Static Properties

Parser
pb::MessageParser<EntityCommandRequest> Parser { get; }


Descriptor
pbr::MessageDescriptor Descriptor { get; }


Properties

Target
global::Improbable.SpatialOS.RemoteInteraction.V1Alpha1.Deployment Target { get; set; }

Deployment targeted by the request.

WorkerType
string WorkerType { get; set; }

Worker type that will be forwarded with the command to the handling worker. The specified string needs to correspond to a worker type defined in the deployment's bridge configurations. This allows for entity commands forwarded through the RIS to impersonate any known worker type. Specifying an unknown worker type will result in an error with an INVALID_ARGUMENT code.

Notes:
  • The regular expression used to validate types is synchronised with the one present in the WorkerType message of proto/improbable/platform/deployment/worker_flagz.proto.

WorkerId
string WorkerId { get; set; }

Worker ID that will be forwarded with the command to the handling worker. This allows for entity commands forwarded through the RIS to impersonate any (in)existent worker.

ComponentTarget
global::Improbable.SpatialOS.RemoteInteraction.V1Alpha1.EntityCommandRequest.Types.EntityCommandTarget ComponentTarget { get; set; }

Target component of the entity command.

Binary
pb::ByteString? Binary { get; set; }

Binary-encoded schema.improbable.EntityCommand message.

PayloadCase
PayloadOneofCase PayloadCase { get; }


Constructors

EntityCommandRequest
EntityCommandRequest()


EntityCommandRequest
EntityCommandRequest(EntityCommandRequest other)

Parameters


Methods

Clone
EntityCommandRequest Clone()


ClearPayload
void ClearPayload()


Equals
bool Equals(EntityCommandRequest other)

Parameters

WriteTo
void WriteTo(pb::CodedOutputStream output)

Parameters
  • pb::CodedOutputStream output :

CalculateSize
int CalculateSize()


MergeFrom
void MergeFrom(EntityCommandRequest other)

Parameters

MergeFrom
void MergeFrom(pb::CodedInputStream input)

Parameters
  • pb::CodedInputStream input :


Overrides

Equals
override bool Equals(object other)

Parameters
  • object other :

GetHashCode
override int GetHashCode()


ToString
override string ToString()

Updated 11 months ago


V1Alpha1.EntityCommandRequest Class


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.