Class Robot

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

Hierarchy

Robot

Index

Constructors

Properties

_heading _position homeIndices id socket startHeading

Accessors

heading position

Methods

absoluteRotate relativeMove relativeRotate

Constructors

constructor

new Robot(socket: RobotSocket, id: string, homeIndices: GridIndices, startHeading?: number, _position?: Position): Robot
Parameters
- socket: RobotSocket
- id: string
- homeIndices: GridIndices
  
  The location the robot lives in when its not in use.
- startHeading: number = 0
- _position: Position = ZERO_POSITION
Returns Robot
- Defined in src/server/robot/robot.ts:13

Properties

`Private` _heading

_heading: number

`Private` _position

_position: Position = ZERO_POSITION

`Readonly` homeIndices

homeIndices: GridIndices

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

`Readonly` id

id: string

`Private` `Readonly` socket

socket: RobotSocket

`Readonly` startHeading

startHeading: number = 0

Accessors

heading

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

position

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

Methods

absoluteRotate

absoluteRotate(heading: number): Promise<void>
Parameters
- heading: number
  
  An absolute heading to turn to.
Returns Promise<void>
- Defined in src/server/robot/robot.ts:45

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>
- Defined in src/server/robot/robot.ts:71

relativeRotate

relativeRotate(deltaHeading: number): Promise<void>
Parameters
- deltaHeading: number
  
  A relative heading to turn by.
Returns Promise<void>
- Defined in src/server/robot/robot.ts:62

Generated using TypeDoc