Commands.WorldCommands.CreateEntity.Request Struct

Namespace: Improbable.Gdk.CoreSource

An object that is a CreateEntity command request.

Inheritance

Improbable.Gdk.Core.Commands.ICommandRequest


Fields

Entity Source
Improbable.Worker.CInterop.Entity Entity


EntityId Source
EntityId? EntityId


TimeoutMillis Source
uint? TimeoutMillis


Context Source
object Context


Constructors

Request Source
Request(EntityTemplate template, EntityId? entityId = null, uint? timeoutMillis = null, object context = null)

Constructor to create a CreateEntity command request payload.

Returns:
The CreateEntity command request payload.

Parameters
  • EntityTemplate template : The EntityTemplate object that defines the SpatialOS components on the to-be-created entity.
  • EntityId? entityId : (Optional) The EntityId that the to-be-created entity should take. This should only be provided if received as the result of a ReserveEntityIds command.
  • uint? timeoutMillis : (Optional) The command timeout in milliseconds. If not specified, will default to 5 seconds.
  • object context : (Optional) A context object that will be returned with the command response.

Updated about a year ago


Commands.WorldCommands.CreateEntity.Request Struct


Suggested Edits are limited on API Reference Pages

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