Class VirtualRobot

Represents a robot. Includes information about the current location as well as tooling for communication.

Hierarchy

Robot
- VirtualRobot

Index

Constructors

Properties

homeIndices id startHeadingRadians

Accessors

headingRadians position

Methods

absoluteRotate getTunnel relativeMove relativeRotate sendDrivePacket sendTurnPacket

Constructors

constructor

new VirtualRobot(id: string, homeIndices: GridIndices, startHeadingRadians?: number, _position?: Position): VirtualRobot
Parameters
- id: string
- homeIndices: GridIndices
  
  The location the robot lives in when its not in use.
- startHeadingRadians: number = 0
- _position: Position = ZERO_POSITION
Returns VirtualRobot
Inherited from Robot.constructor
- Defined in src/server/robot/robot.ts:14

Properties

`Readonly` homeIndices

homeIndices: GridIndices

The location the robot lives in when its not in use.

`Readonly` id

id: string

`Readonly` startHeadingRadians

startHeadingRadians: number = 0

Accessors

headingRadians

get headingRadians(): number
Returns number
Inherited from Robot.headingRadians
- Defined in src/server/robot/robot.ts:34
set headingRadians(headingRadians: number): void
Parameters
- headingRadians: number
Returns void
Inherited from Robot.headingRadians
- Defined in src/server/robot/robot.ts:38

position

get position(): Position
Returns Position
Inherited from Robot.position
- Defined in src/server/robot/robot.ts:26
set position(coords: Position): void
Parameters
- coords: Position
Returns void
Inherited from Robot.position
- Defined in src/server/robot/robot.ts:30

Methods

absoluteRotate

absoluteRotate(headingRadians: number): Promise<void>
Parameters
- headingRadians: number
  
  An absolute heading to turn to, in radians. 0 is up (from white to black). CW is positive.
Returns Promise<void>
Inherited from Robot.absoluteRotate
- Defined in src/server/robot/robot.ts:45

getTunnel

getTunnel(): BotTunnel
Returns BotTunnel
Overrides Robot.getTunnel
- Defined in src/server/simulator.ts:138

relativeMove

relativeMove(deltaPosition: Position): Promise<void>
Turns and drives the robot to this.position + deltaPosition.
Parameters
- deltaPosition: Position
  
  The amount to offset the current position by.
Returns Promise<void>
Inherited from Robot.relativeMove
- Defined in src/server/robot/robot.ts:73

relativeRotate

relativeRotate(deltaHeadingRadians: number): Promise<void>
Parameters
- deltaHeadingRadians: number
  
  A relative heading to turn by, in radians.
Returns Promise<void>
Inherited from Robot.relativeRotate
- Defined in src/server/robot/robot.ts:62

sendDrivePacket

sendDrivePacket(tileDistance: number): Promise<void>
Send a packet to the robot indicating distance to drive. Returns a promise that finishes when the robot finishes the action.
Parameters
- tileDistance: number
  
  The distance to drive forward or backwards by. 1 is defined as the length of a tile.
Returns Promise<void>
Inherited from Robot.sendDrivePacket
- Defined in src/server/robot/robot.ts:111

sendTurnPacket

sendTurnPacket(deltaHeadingRadians: number): Promise<void>
Send a packet to the robot indicating angle to turn. Returns a promise that finishes when the robot finishes the action.
Parameters
- deltaHeadingRadians: number
  
  A relative heading to turn by, in radians. May be positive or negative.
Returns Promise<void>
Inherited from Robot.sendTurnPacket
- Defined in src/server/robot/robot.ts:95

Generated using TypeDoc