Class Robot

Hierarchy

WikModel
- Robot

Index

Constructors

Properties

$$isEmitter $$parent $$views error id noEmit path px py pz theta zone

Methods

$set fire fire$n fromJSON getSnapshot listen listen$1 listen$n readOnly remove reqEffectCall setEventChild setEventParent setPosition setTheta snapshot toJSON toSnapshot unlisten unlisten$n

Constructors

constructor

new Robot(): Robot
Returns Robot
Inherited from WikModel.constructor
- Defined in node_modules/eventemitter3/index.d.ts:88

Properties

`Readonly` $$isEmitter

$$isEmitter: true

`Readonly` $$parent

$$parent: IList<Base<string>> = null

The parent of event.

List is a parent of Base or Layer.

This field has the name $$parent declared, which keep consistent with /model/basic/Base.class

`Readonly` $$views

$$views: View<Base<string>, string>[] = []

error

error: boolean = false

`Readonly` id

id: string = ...

noEmit

noEmit: boolean

set it True, the follow emit will be ignore and then set it False.

path

path: any = null

px

px: number = 0

py

py: number = 0

pz

pz: number = 0

theta

theta: number = 0

zone

zone: string

Methods

$set

$set(pairs: string | Record<string, any>, value?: any, context?: object): void
Parameters
- pairs: string | Record<string, any>
- Optional value: any
- Optional context: object
Returns void
Inherited from WikModel.$set
- Defined in src/model/basic/Core.class.ts:7

fire

fire<T>(event: T, payload?: PlainObject): boolean
Type Parameters
- T extends string
Parameters
- event: T
- Optional payload: PlainObject
Returns boolean
Inherited from WikModel.fire
- Defined in src/model/basic/Emitter.ts:147

fire$n

fire$n(event: string, payload?: PlainObject): Robot
split fire
Parameters
- event: string
- Optional payload: PlainObject
Returns Robot
Inherited from WikModel.fire$n
- Defined in src/model/basic/Emitter.ts:151

fromJSON

fromJSON(d: any): Robot
Parameters
- d: any
Returns Robot
Inherited from WikModel.fromJSON
- Defined in src/model/WikModel.class.ts:8

getSnapshot

getSnapshot(): any
Returns any
Inherited from WikModel.getSnapshot
- Defined in src/model/basic/Snapshot.ts:35

listen

listen<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): Robot
on
Type Parameters
- T extends string
Parameters
- event: T
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
- Optional context: any
Returns Robot
Inherited from WikModel.listen
- Defined in src/model/basic/Emitter.ts:155

listen$1

listen$1<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): Robot
once
Type Parameters
- T extends string
Parameters
- event: T
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
- Optional context: any
Returns Robot
Inherited from WikModel.listen$1
- Defined in src/model/basic/Emitter.ts:172

listen$n

listen$n(event: string, fn: ((event: WikEvent<any, any>) => void)): Robot
split on
Parameters
- event: string
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns Robot
Inherited from WikModel.listen$n
- Defined in src/model/basic/Emitter.ts:159

readOnly

readOnly<V>(key: string, value: V): void
Type Parameters
- V = any
Parameters
- key: string
- value: V
Returns void
Inherited from WikModel.readOnly
- Defined in src/model/basic/Core.class.ts:22

remove

remove(): void
Returns void
Inherited from WikModel.remove
- Defined in src/model/basic/Base.class.ts:44

reqEffectCall

reqEffectCall(req: string | EffectCallReq): void
Call an effect responses on views.
Parameters
- req: string | EffectCallReq
Returns void
Inherited from WikModel.reqEffectCall
- Defined in src/model/basic/Base.class.ts:53

setEventChild

setEventChild(child: WithEmitter<string>, off?: boolean): Robot
Create parent-child relationships of two evented objects manually. Because this method not mounted on evented object.
Parameters
- child: WithEmitter<string>
- Optional off: boolean
Returns Robot
Inherited from WikModel.setEventChild
- Defined in src/model/basic/Emitter.ts:178

setEventParent

setEventParent(parent: WithEmitter<string>): Robot
Parameters
- parent: WithEmitter<string>
Returns Robot
Inherited from WikModel.setEventParent
- Defined in src/model/basic/Emitter.ts:180

setPosition

setPosition(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
- Defined in src/model/Robot.class.ts:22

setTheta

setTheta(deg: number): void
Parameters
- deg: number
Returns void
- Defined in src/model/Robot.class.ts:28

snapshot

snapshot(): void
Returns void
Inherited from WikModel.snapshot
- Defined in src/model/basic/Snapshot.ts:36

toJSON

toJSON(): {}
Returns {}
Inherited from WikModel.toJSON
- Defined in src/model/WikModel.class.ts:12

toSnapshot

toSnapshot(): any
Returns any
Inherited from WikModel.toSnapshot
- Defined in src/model/WikModel.class.ts:4

unlisten

unlisten<T>(event: T, fn?: ((event: WikEvent<any, any>) => void)): Robot
off
Type Parameters
- T extends string
Parameters
- event: T
- Optional fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns Robot
Inherited from WikModel.unlisten
- Defined in src/model/basic/Emitter.ts:163

unlisten$n

unlisten$n(event: string, fn?: ((event: WikEvent<any, any>) => void)): Robot
split off
Parameters
- event: string
- Optional fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns Robot
Inherited from WikModel.unlisten$n
- Defined in src/model/basic/Emitter.ts:167

Class Robot

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Robot

Properties

Readonly $$isEmitter

Readonly $$parent

Readonly $$views

error

Readonly id

noEmit

path

px

py

pz

theta

zone

Methods

$set

Parameters

pairs: string | Record<string, any>

Optional value: any

Optional context: object

Returns void

fire

Type Parameters

T extends string

Parameters

event: T

Optional payload: PlainObject

Returns boolean

fire$n

Parameters

event: string

Optional payload: PlainObject

Returns Robot

fromJSON

Parameters

d: any

Returns Robot

getSnapshot

Returns any

listen

Type Parameters

T extends string

Parameters

event: T

fn: ((event: WikEvent<any, any>) => void)

Parameters

event: WikEvent<any, any>

Returns void

Optional context: any

Returns Robot

listen$1

Type Parameters

T extends string

Parameters

event: T

fn: ((event: WikEvent<any, any>) => void)

Parameters

event: WikEvent<any, any>

Returns void

Optional context: any

Returns Robot

listen$n

Parameters

event: string

fn: ((event: WikEvent<any, any>) => void)

Parameters

event: WikEvent<any, any>

Returns void

Returns Robot

readOnly

Type Parameters

V = any

`Readonly` $$isEmitter

`Readonly` $$parent

`Readonly` $$views

`Readonly` id

`Optional` value: any

`Optional` context: object

`Optional` payload: PlainObject

`Optional` payload: PlainObject

`Optional` context: any

`Optional` context: any

`Optional` off: boolean

`Optional` fn: ((event: WikEvent<any, any>) => void)

`Optional` fn: ((event: WikEvent<any, any>) => void)