Class Robot

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

Hierarchy

Robot
- VirtualRobot

Index

Constructors

constructor

new Robot(id: string, homeIndices: GridIndices, defaultIndices: GridIndices, startHeadingRadians?: number, position?: Position): Robot
Parameters
- id: string
- homeIndices: GridIndices
  
  The location the robot lives in when its not in use.
- defaultIndices: GridIndices
  
  The location the robot should be in at the beginning of a regular chess.
- startHeadingRadians: number = 0
- Optional position: Position
Returns Robot
- Defined in src/server/robot/robot.ts:16

Properties

`Private` _headingRadians

_headingRadians: number

`Private` _position

_position: Position

`Readonly` defaultIndices

defaultIndices: GridIndices

The location the robot should be in at the beginning of a regular chess.

`Readonly` homeIndices

homeIndices: GridIndices

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

`Readonly` id

id: string

`Readonly` startHeadingRadians

startHeadingRadians: number = 0

`Protected` tunnel

tunnel: null | BotTunnel

Accessors

headingRadians

get headingRadians(): number
Returns number
- Defined in src/server/robot/robot.ts:48
set headingRadians(headingRadians: number): void
Parameters
- headingRadians: number
Returns void
- Defined in src/server/robot/robot.ts:52

position

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

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

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:87

relativeRotate

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

sendDriveCubicPacket

sendDriveCubicPacket(startPosition: {
    x: number;
    y: number;
}, endPosition: {
    x: number;
    y: number;
}, controlPositionA: {
    x: number;
    y: number;
}, controlPositionB: {
    x: number;
    y: number;
}, timeDeltaMs: number): Promise<void>
Parameters
- startPosition: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
- endPosition: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
- controlPositionA: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
- controlPositionB: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
- timeDeltaMs: number
Returns Promise<void>
- Defined in src/server/robot/robot.ts:147

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

sendDriveQuadraticPacket

sendDriveQuadraticPacket(startPosition: {
    x: number;
    y: number;
}, endPosition: {
    x: number;
    y: number;
}, controlPosition: {
    x: number;
    y: number;
}, timeDeltaMs: number): Promise<void>
Parameters
- startPosition: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
- endPosition: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
- controlPosition: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
- timeDeltaMs: number
Returns Promise<void>
- Defined in src/server/robot/robot.ts:164

sendDriveTicksPacket

sendDriveTicksPacket(distanceTicks: number): Promise<void>
Send a packet to the robot indicating distance to drive, in ticks. Returns a promise that finishes when the robot finishes the action.
Parameters
- distanceTicks: number
  
  The distance to drive forward or backwards by, in ticks.
Returns Promise<void>
- Defined in src/server/robot/robot.ts:140

sendSpinPacket

sendSpinPacket(radians: number, timeDeltaMs: number): Promise<void>
Parameters
- radians: number
- timeDeltaMs: number
Returns Promise<void>
- Defined in src/server/robot/robot.ts:179

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

setTunnel

setTunnel(tunnel: BotTunnel): void
Parameters
- tunnel: BotTunnel
Returns void
- Defined in src/server/robot/robot.ts:101

Class Robot

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: string

homeIndices: GridIndices

defaultIndices: GridIndices

startHeadingRadians: number = 0

Optional position: Position

Returns Robot

Properties

Private _headingRadians

Private _position

Readonly defaultIndices

Readonly homeIndices

Readonly id

Readonly startHeadingRadians

Protected tunnel

Accessors

headingRadians

Returns number

Parameters

headingRadians: number

Returns void

position

Returns Position

Parameters

coords: Position

Returns void

Methods

absoluteRotate

Parameters

headingRadians: number

Returns Promise<void>

relativeMove

Parameters

deltaPosition: Position

Returns Promise<void>

relativeRotate

Parameters

deltaHeadingRadians: number

Returns Promise<void>

sendDriveCubicPacket

Parameters

startPosition: { x: number; y: number; }

x: number

y: number

endPosition: { x: number; y: number; }

x: number

y: number

controlPositionA: { x: number; y: number; }

x: number

y: number

controlPositionB: { x: number; y: number; }

x: number

y: number

timeDeltaMs: number

Returns Promise<void>

sendDrivePacket

Parameters

tileDistance: number

Returns Promise<void>

sendDriveQuadraticPacket

Parameters

startPosition: { x: number; y: number; }

x: number

y: number

endPosition: { x: number; y: number; }

x: number

y: number

controlPosition: { x: number; y: number; }

x: number

y: number

timeDeltaMs: number

`Optional` position: Position

`Private` _headingRadians

`Private` _position

`Readonly` defaultIndices

`Readonly` homeIndices

`Readonly` id

`Readonly` startHeadingRadians

`Protected` tunnel

startPosition: {
x: number;
y: number;
}

endPosition: {
x: number;
y: number;
}

controlPositionA: {
x: number;
y: number;
}

controlPositionB: {
x: number;
y: number;
}

startPosition: {
x: number;
y: number;
}

endPosition: {
x: number;
y: number;
}

controlPosition: {
x: number;
y: number;
}