Class SimulatorUpdateMessage

An update message for the simulator with the robot id, rotation and position

Hierarchy

Message
- SimulatorUpdateMessage

Index

Constructors

Properties

location packet robotId stackTrace? type

Methods

Constructors

constructor

new SimulatorUpdateMessage(robotId: string, location: SimulatedRobotLocation, packet: PacketWithId, stackTrace?: StackFrame[]): SimulatorUpdateMessage
Parameters
- robotId: string
- location: SimulatedRobotLocation
- packet: PacketWithId
- Optional stackTrace: StackFrame[]
Returns SimulatorUpdateMessage
Overrides Message.constructor
- Defined in src/common/message/simulator-message.ts:21

Properties

`Readonly` location

location: SimulatedRobotLocation

`Readonly` packet

packet: PacketWithId

`Readonly` robotId

robotId: string

`Optional` `Readonly` stackTrace

stackTrace?: StackFrame[]

`Protected` type

type: MessageType = MessageType.SIMULATOR_UPDATE

Methods

toJson

toJson(): string
Serializes the message as json.

Returns string
Inherited from Message.toJson
- Defined in src/common/message/message.ts:62

`Protected` toObj

toObj(): object
Sends this class to an object which can be serialized as json. The only usage of this method is by toJson.

Returns object
Overrides Message.toObj
- Defined in src/common/message/simulator-message.ts:30

Generated using TypeDoc