Class TargetDeclaredRunner<T>

targetプロパティが確定したRunner

Type Parameters

T = any

Hierarchy

Runner2D<T>
- TargetDeclaredRunner

Index

Constructors

constructor

new TargetDeclaredRunner<T>(target?: T): TargetDeclaredRunner<T>
Type Parameters
- T = any
Parameters
- Optional target: T
Returns TargetDeclaredRunner<T>
Inherited from Runner2D.constructor
- Defined in runner/BaseRunner.ts:20

Properties

`Protected` `Optional` _generator

_generator?: Generator<unknown, any, unknown>

`Protected` _isAwake

_isAwake: boolean = true

`Protected` _loop

_loop: boolean = false

`Protected` _taskList

_taskList: CoroutineTask[] = []

addAction

addAction: ((action: RunnerAction<T>, ...args: any) => TargetDeclaredRunner<T>)

Type declaration

- (action: RunnerAction<T>, ...args: any): TargetDeclaredRunner<T>
- Parameters
  - action: RunnerAction<T>
  - Rest ...args: any
  Returns TargetDeclaredRunner<T>

target

target: T

Runner対象オブジェクト

`Protected` vector

vector: Readonly<Vector2> = ...

vectorプロパティは保護されてます。取得する場合はgetVectorメソッドを使用のこと

Accessors

dead

get dead(): boolean
[jp] 稼働中の内部ジェネレータがあるかどうかを返す

[en] Returns true when inner-generator doesn't exists

Returns boolean
Inherited from Runner2D.dead
- Defined in runner/Coroutine.ts:185

isAwake

get isAwake(): boolean
[jp] 稼働状態を返す。 falseの際はstepを実行しても進まない pause/resumeなどで更新

[en] Return isAwake

Returns boolean
Inherited from Runner2D.isAwake
- Defined in runner/Coroutine.ts:199

speed

get speed(): number
速度（vector長）

Returns number
Inherited from Runner2D.speed
- Defined in runner/Runner2D.ts:173

vectorAngle

get vectorAngle(): number
vectorの向きをラジアン値で返す

Returns number
Inherited from Runner2D.vectorAngle
- Defined in runner/Runner2D.ts:200

vx

get vx(): number
x軸進行方向（vector.x）

Returns number
Inherited from Runner2D.vx
- Defined in runner/Runner2D.ts:180
set vx(v: number): void
Parameters
- v: number
Returns void
Inherited from Runner2D.vx
- Defined in runner/Runner2D.ts:183

vy

get vy(): number
y軸進行方向（vector.y）

Returns number
Inherited from Runner2D.vy
- Defined in runner/Runner2D.ts:190
set vy(v: number): void
Parameters
- v: number
Returns void
Inherited from Runner2D.vy
- Defined in runner/Runner2D.ts:193

`Static` actionDictionary

get actionDictionary(): Map<string, ((...args: any[]) => Generator<unknown, any, unknown>)>
Returns Map<string, ((...args: any[]) => Generator<unknown, any, unknown>)>
Inherited from Runner2D.actionDictionary
- Defined in runner/Runner2D.ts:210

Methods

addActionByName

addActionByName(actionName: string, ...args: any): TargetDeclaredRunner<T>

(WIP, maybe removed)

[en] Add action with pre-registered action name

[jp] 予め登録したアクション名でアクションを追加

Example

import {ActionDictionary,BaseRunner} from "pgul"

ActionDictionary.register("goto", function* (x, duration) {
  let count = 0;
  const progressUnit = (x - this.target.x) / duration;
  while (count < duration) {
    this.target.x += progressUnit;
    yield count++;
  }
});

// Load action
const runner = new BaseRunner<any, "goto">();
runner.addActionByName("goto", 200, 120);

Returns

Parameters

actionName: string
Rest ...args: any

args for runnerAction

Returns TargetDeclaredRunner<T>

addTask

addTask(taskObj: CoroutineTask, resetAfterAdding?: boolean): TargetDeclaredRunner<T>
[jp] タスクを追加

[en] Add coroutine task

Returns
this
Parameters
- taskObj: CoroutineTask
  
  func<*function>とarguments<any[]>をもったオブジェクト
- resetAfterAdding: boolean = false
  
  追加後に内部Generatorをリセットするかどうか
Returns TargetDeclaredRunner<T>
Inherited from Runner2D.addTask
- Defined in runner/Coroutine.ts:65

addTaskFromJSON

addTaskFromJSON(taskJson: CoroutineTask[]): TargetDeclaredRunner<T>
[jp] JSONでタスク設定

[en] addTaskFromJSON

Returns
this
Parameters
- taskJson: CoroutineTask[]
Returns TargetDeclaredRunner<T>
Inherited from Runner2D.addTaskFromJSON
- Defined in runner/Coroutine.ts:81

clear

clear(): TargetDeclaredRunner<T>
[jp] 内部Generatorをクリア（コルーチン処理消去）

[en] Clear current running generator.

Returns
this

Returns TargetDeclaredRunner<T>
Inherited from Runner2D.clear
- Defined in runner/Coroutine.ts:159

getDirection

getDirection(): number
度数単位で現在の進行方向（vector方向）を取得

Returns number
Inherited from Runner2D.getDirection
- Defined in runner/Runner2D.ts:92

getDirectionByRadian

getDirectionByRadian(): number
ラジアン単位で現在の進行方向（vector方向）を取得

Returns number
Inherited from Runner2D.getDirectionByRadian
- Defined in runner/Runner2D.ts:101

getVector

getVector(): Vector2
vectorのクローンオブジェクトを返す

Returns Vector2
Inherited from Runner2D.getVector
- Defined in runner/Runner2D.ts:166

pause

pause(): TargetDeclaredRunner<T>
[jp] 処理をポーズする（step処理をスキップするようにする）

[en] Pause coroutine stepping.

Returns
this

Returns TargetDeclaredRunner<T>
Inherited from Runner2D.pause
- Defined in runner/Coroutine.ts:131

reset

reset(): TargetDeclaredRunner<T>
[jp] taskリストからジェネレーターをリセット

[en] Reset

Returns
this

Returns TargetDeclaredRunner<T>
Inherited from Runner2D.reset
- Defined in runner/Coroutine.ts:98

resume

resume(): TargetDeclaredRunner<T>
[jp] ポーズ中の処理を再開

[en] Resume coroutine stepping.

Returns
this

Returns TargetDeclaredRunner<T>
Inherited from Runner2D.resume
- Defined in runner/Coroutine.ts:145

rotateVector

rotateVector(addedAngleRadian: number): TargetDeclaredRunner<T>
進行方向（vector）を回転
Parameters
- addedAngleRadian: number
Returns TargetDeclaredRunner<T>
Inherited from Runner2D.rotateVector
- Defined in runner/Runner2D.ts:142

setDirection

setDirection(degree: number, speed?: number): TargetDeclaredRunner<T>
進行方向（vector方向）をセット（度数単位）
Parameters
- degree: number
  
  度数単位
- Optional speed: number
Returns TargetDeclaredRunner<T>
Inherited from Runner2D.setDirection
- Defined in runner/Runner2D.ts:123

setDirectionByRadian

setDirectionByRadian(radian: number): TargetDeclaredRunner<T>
進行方向（vector方向）をセット（ラジアン単位）

Alias
setVectorAngle
Parameters
- radian: number
Returns TargetDeclaredRunner<T>
Inherited from Runner2D.setDirectionByRadian
- Defined in runner/Runner2D.ts:134

setLoop

setLoop(flag?: boolean): TargetDeclaredRunner<T>
[jp] ループを設定

[en] Whether to reset generator after it is "done".

Returns
this
Parameters
- flag: boolean = true
Returns TargetDeclaredRunner<T>
Inherited from Runner2D.setLoop
- Defined in runner/Coroutine.ts:173

setSpeed

setSpeed(speed: number): TargetDeclaredRunner<T>
速度をセット（内部的にはvector長をセット）
Parameters
- speed: number
Returns TargetDeclaredRunner<T>
Inherited from Runner2D.setSpeed
- Defined in runner/Runner2D.ts:152

setTarget

setTarget(target: T): TargetDeclaredRunner<T>
Parameters
- target: T
Returns TargetDeclaredRunner<T>
Inherited from Runner2D.setTarget
- Defined in runner/BaseRunner.ts:28

setVector

setVector(x?: number, y?: number): TargetDeclaredRunner<T>
vectorパラメータをセット

内部ラジアン値及びスピード値も同時に変更される
Parameters
- Optional x: number
  
  無指定の場合はそのまま
- Optional y: number
  
  無指定の場合はそのまま
Returns TargetDeclaredRunner<T>
Inherited from Runner2D.setVector
- Defined in runner/Runner2D.ts:81

setVectorAngle

setVectorAngle(radian: number): TargetDeclaredRunner<T>
進行方向（vector方向）をセット（ラジアン単位）

Alias
setDirectionByRadian
Parameters
- radian: number
Returns TargetDeclaredRunner<T>
Inherited from Runner2D.setVectorAngle
- Defined in runner/Runner2D.ts:113

start

start(): TargetDeclaredRunner<T>
[jp] step可能にする内部ジェネレーターリセットも兼ねる

[en] Reset and enable coroutine stepping

Returns
this

Returns TargetDeclaredRunner<T>
Inherited from Runner2D.start
- Defined in runner/Coroutine.ts:116

step

step(): void | IteratorResult<any, any>
[jp] ルーチン処理を進めるループが有効な場合はジェネレーターをリセットする

[en] Step inner Generator

Returns
稼働状態であればnext結果を返す

Returns void | IteratorResult<any, any>
Inherited from Runner2D.step
- Defined in runner/Coroutine.ts:35

`Static` convertTaskListToGenarator

convertTaskListToGenarator(taskList: CoroutineTask[], context: Coroutine): Generator<unknown, void, unknown>
[jp] taskリストをジェネレーターオブジェクトに変換

[en] convertTaskListToGenarator

Returns
Converted Generator
Parameters
- taskList: CoroutineTask[]
- context: Coroutine
  
  task.actionのthisとして扱うオブジェクト
Returns Generator<unknown, void, unknown>
Inherited from Runner2D.convertTaskListToGenarator
- Defined in runner/Coroutine.ts:214

`Static` registerAction

registerAction(...params: [name: string, genFunc: ((this: BaseRunner<any, string>, ...args: any[]) => Generator<unknown, any, unknown>)]): void
Parameters
- Rest ...params: [name: string, genFunc: ((this: BaseRunner<any, string>, ...args: any[]) => Generator<unknown, any, unknown>)]
Returns void
Inherited from Runner2D.registerAction
- Defined in runner/Runner2D.ts:204

Class TargetDeclaredRunner<T>

Type Parameters

T = any

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T = any

Parameters

Optional target: T

Returns TargetDeclaredRunner<T>

Properties

Protected Optional _generator

Protected _isAwake

Protected _loop

Protected _taskList

addAction

Type declaration

Parameters

action: RunnerAction<T>

Rest ...args: any

Returns TargetDeclaredRunner<T>

target

Protected vector

Accessors

dead

Returns boolean

isAwake

Returns boolean

speed

Returns number

vectorAngle

Returns number

vx

Returns number

Parameters

v: number

Returns void

vy

Returns number

Parameters

v: number

Returns void

Static actionDictionary

Returns Map<string, ((...args: any[]) => Generator<unknown, any, unknown>)>

Methods

addActionByName

Example

Returns

Parameters

actionName: string

Rest ...args: any

Returns TargetDeclaredRunner<T>

addTask

Returns

Parameters

taskObj: CoroutineTask

resetAfterAdding: boolean = false

Returns TargetDeclaredRunner<T>

addTaskFromJSON

Returns

Parameters

taskJson: CoroutineTask[]

Returns TargetDeclaredRunner<T>

clear

Returns

Returns TargetDeclaredRunner<T>

getDirection

Returns number

getDirectionByRadian

Returns number

getVector

Returns Vector2

pause

Returns

`Optional` target: T

`Protected` `Optional` _generator

`Protected` _isAwake

`Protected` _loop

`Protected` _taskList

`Rest` ...args: any

`Protected` vector

`Static` actionDictionary

`Rest` ...args: any

`Optional` speed: number

`Optional` x: number

`Optional` y: number

`Static` convertTaskListToGenarator

`Static` registerAction

`Rest` ...params: [name: string, genFunc: ((this: BaseRunner<any, string>, ...args: any[]) => Generator<unknown, any, unknown>)]