Class RandomPickableList<T>

[en] Add random pickup feature to List class

[jp] Listクラスにランダムピックアップ機能追加

Type Parameters

  • T = any

Hierarchy

  • List<T>
    • RandomPickableList

Constructors

constructor

Properties

_limitSize? _list _random?

Accessors

current currentIndex last lastIndex length

Methods

_setIndexAndReturnValue clear decrement getList getSize increment isPointerAtFirst isPointerAtLast pop push randomPick setIndex setRandomSeed setSize

Constructors

constructor

Properties

Protected Optional _limitSize

_limitSize?: number

Protected _list

_list: T[]

Protected Optional _random

_random?: Random

Accessors

current

  • get current(): T

  • 現在の内部インデックス値に対応する要素を返す

    Returns T

currentIndex

  • get currentIndex(): number

  • 現在の内部インデックス値

    Returns number

last

  • get last(): T

  • List内最後の要素を返す

    Returns T

lastIndex

  • get lastIndex(): number

  • 内部インデックス最大値（≒List内の全要素数）

    Returns number

length

  • get length(): number

  • Array.lengthと一緒

    Returns number

Methods

Protected _setIndexAndReturnValue

  • _setIndexAndReturnValue(i: number): T

  • 内部インデックス値を設定しつつ、対応する要素を返す （内部処理用）

    Parameters

    • i: number

    Returns T

clear

decrement

  • 内部インデックス値を減じながら、対応する要素を返す.

    Parameters

    • loop: boolean = true

      インデックスをオーバーしたときループするかどうか falseの場合、オーバーしそうになったら0で固定

    Returns T

getList

  • 複製した内部配列を返す（シャロ―クローン）

    Returns T[]

getSize

  • リストサイズ値を取得

    Returns

    サイズ値、未設定のときはundefined

    Returns undefined | number

increment

  • 内部インデックス値を進めながら、対応する要素を返す.

    Parameters

    • loop: boolean = true

      インデックスをオーバーしたときループするかどうか（default: true） falseの場合、オーバーしそうになったら最大インデックスで固定

    Returns T

isPointerAtFirst

  • 内部ポインタインデックス値がリスト先頭にあるかどうか

    Returns boolean

isPointerAtLast

  • 内部ポインタインデックス値がリスト終端にあるかどうか

    Returns boolean

pop

  • Array.popラッパー

    Returns undefined | T

push

  • 通常はArray.pushと同じ ただしサイズが設定されている場合、 サイズ超過時に頭の要素が押し出されて返却される

    複数pushした場合、押し出した分を配列として返却

    Parameters

    • Rest ...arg: T[]

    Returns number | T | T[]

randomPick

  • [jp] 無作為に選ぶ

    Parameters

    • Optional random: Random

      [jp] 無指定の場合はインスタンスごとの内部Randomモジュール使用

    Returns T

setIndex

  • 内部インデックス値を設定しつつ、対応する要素を返す 範囲外のインデックス値はセットできず、undefinedを返す

    Returns

    [jp] インデックスに対応する要素。セットできなかったら場合はundefined

    Parameters

    • i: number

      index

    Returns undefined | T

setRandomSeed

  • [jp] 内部Randomモジュールのシード値を設定

    Parameters

    • seed: number

    Returns void

setSize

  • リストのサイズ（格納可能な要素数）を設定する

    Parameters

    • v: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc