List

.Structs. List

列表是有序列表的一般实现,它包含用于检索,操作和迭代项目的实用方法.

Constructor

new List(parent)

Since:
  • 3.0.0
Parameters:
Name Type Description
parent * 此列表的父列表.

Members

_sortKey :string

Since:
  • 3.4.0
排序依据的属性键.
Type:
  • string

addCallback :function

Since:
  • 3.4.0
每次向该列表添加子对象时调用的回调.
Type:
  • function

(readonly) first :*

Since:
  • 3.0.0
列表中的第一项或空列表的 `null` .
Type:
  • *

(readonly) last :*

Since:
  • 3.0.0
列表中的最后一项,或空列表的 `null` .
Type:
  • *

(readonly) length :number

Since:
  • 3.0.0
列表中的项目数.
Type:
  • number

list :Array.<*>

Since:
  • 3.0.0
Default Value:
  • []
属于此集合的对象.
Type:
  • Array.<*>

(readonly) next :*

Since:
  • 3.0.0
列表中的下一个项目,如果已经遍历了整个列表,则为 `null` . 在读取#first或手动设置#position以循环访问列表后,可以连续读取此属性.
Type:
  • *

parent :*

Since:
  • 3.0.0
此列表的父列表.
Type:
  • *

position :number

Since:
  • 3.0.0
Default Value:
  • 0
当前元素的索引. 当使用#first,#last,#get#previous属性遍历列表时,会在内部使用此选项.
Type:
  • number

(readonly) previous :*

Since:
  • 3.0.0
列表中的前一项,如果整个列表已被遍历,则为 `null` . 在读取#last或手动设置#position以向后循环列表后,可以连续读取此属性.
Type:
  • *

removeCallback :function

Since:
  • 3.4.0
每次从该列表中移除子级时调用的回调.
Type:
  • function

Methods

add(child, skipCallbackopt) → {*}

Since:
  • 3.0.0
将给定项目添加到列表的末尾.每个项目必须是唯一的.
Parameters:
Name Type Attributes Default Description
child * | Array.<*> 要添加到列表中的项或项数组.
skipCallback boolean <optional>
false 如果成功添加了该子级,则跳过调用List.addCallback.
Returns:
列表的底层数组.
Type
*

addAt(child, indexopt, skipCallbackopt) → {*}

Since:
  • 3.0.0
从指定的索引开始,将项目添加到列表中.列表中的每个项目都必须是唯一的.
Parameters:
Name Type Attributes Default Description
child * 要添加到列表中的项或项数组.
index number <optional>
0 列表中要插入元素的索引.
skipCallback boolean <optional>
false 如果成功添加了该子级,则跳过调用List.addCallback.
Returns:
列表的底层数组.
Type
*

bringToTop(child) → {*}

Since:
  • 3.0.0
将给定的孩子放在列表的顶部.
Parameters:
Name Type Description
child * 要放在列表顶部的项目.
Returns:
被移动的项目.
Type
*

count(property, value) → {number}

Since:
  • 3.0.0
返回列表中具有与给定值匹配的属性的项目总数.
Parameters:
Name Type Description
property string 要在每个项目上测试的属性.
value * 测试属性所依据的值.
Returns:
匹配元素的总数.
Type
number

destroy()

Since:
  • 3.0.0
销毁此列表.

each(callback, contextopt, …argsopt)

Since:
  • 3.0.0
将所有子级传递给给定的回调.
Parameters:
Name Type Attributes Description
callback EachListCallback 要调用的函数.
context * <optional>
执行回调时用作 `this` 的值.
args * <optional>
<repeatable>
将传递给回调的附加参数,在子级之后.

exists(child) → {boolean}

Since:
  • 3.0.0
检查列表中是否存在项目.
Parameters:
Name Type Description
child * 要检查是否存在的项目.
Returns:
如果在列表中找到该项目,则为 `true` ,否则为 `false` .
Type
boolean

getAll(propertyopt, valueopt, startIndexopt, endIndexopt) → {Array.<*>}

Since:
  • 3.0.0
返回此列表中的所有子项. 您可以选择使用 `property` 和 `value` 参数指定匹配条件. 例如: `getAll(`parent` )`将只返回具有名为 `parent` 的属性的子级. 您也可以指定一个值来比较属性: `getAll(`visible` ,true)`将只返回其可见属性设置为 `true` 的子级. 您可以选择指定开始和结束索引.例如,如果此列表有100个孩子, 如果将 `startIndex` 设置为0,将 `endIndex` 设置为50,它将只返回匹配项 名单上的前50个孩子.
Parameters:
Name Type Attributes Description
property string <optional>
根据值参数进行测试的可选属性.
value * <optional>
如果设置了属性,则子属性必须严格等于该值才能包含在结果中.
startIndex number <optional>
开始搜索的第一个子索引.
endIndex number <optional>
要搜索到的最后一个子索引.
Returns:
列表中符合给定标准的所有项目(如果有).
Type
Array.<*>

getAt(index) → {*}

Since:
  • 3.0.0
检索列表中给定位置的项目.
Parameters:
Name Type Description
index number 项目的索引.
Returns:
检索到的项目,如果它在列表的边界之外,则为 `undefined` .
Type
*

getByName(name) → (nullable) {*}

Since:
  • 3.0.0
搜索第一个子实例及其 `name` 与给定参数匹配的属性.应该不止一个孩子 只返回第一个相同的名称.
Parameters:
Name Type Description
name string 要搜索的名称.
Returns:
具有匹配名称的第一个子级,如果没有找到,则为null.
Type
*

getFirst(property, value, startIndexopt, endIndexopt) → (nullable) {*}

Since:
  • 3.0.0
返回列表给定部分中符合特定条件的第一个元素.
Parameters:
Name Type Attributes Default Description
property string 要测试的属性的名称或没有标准的假值.
value * 测试 `property` 所依据的值,或 `undefined` 以允许任何值,并且只检查是否存在.
startIndex number <optional>
0 列表中开始搜索的位置.
endIndex number <optional>
列表中可选择停止搜索的位置.不会查的.
Returns:
符合给定标准的第一项,如果不存在该项,则为 `null` .
Type
*

getIndex(child) → {number}

Since:
  • 3.0.0
在列表中定位一个项目并返回其索引.
Parameters:
Name Type Description
child * 要定位的项目.
Returns:
The index of the item within the List, or -1 if it's not in the List.
Type
number

getRandom(startIndexopt, lengthopt) → (nullable) {*}

Since:
  • 3.0.0
从组中返回一个随机子级.
Parameters:
Name Type Attributes Default Description
startIndex number <optional>
0 从组的前面偏移(最低的子组).
length number <optional>
(to top) 对要随机选择的值的数量的限制.
Returns:
这个组的随机孩子.
Type
*

moveDown(child) → {*}

Since:
  • 3.0.0
将该组中的给定子代下移一个位置,除非它已经在底部.
Parameters:
Name Type Description
child * 要下移的项目.
Returns:
被移动的项目.
Type
*

moveTo(child, index) → {*}

Since:
  • 3.0.0
将列表中的项目移动到新位置.
Parameters:
Name Type Description
child * 要移动的项目.
index number 将列表中的项目移动到新位置.
Returns:
被移动的项目.
Type
*

moveUp(child) → {*}

Since:
  • 3.0.0
将给定的孩子在该组中上移一个位置,除非它已经在顶部.
Parameters:
Name Type Description
child * 要上移的项目.
Returns:
被移动的项目.
Type
*

remove(child, skipCallbackopt) → {*}

Since:
  • 3.0.0
从列表中删除一个或多个项目.
Parameters:
Name Type Attributes Default Description
child * 要移除的项或项数组.
skipCallback boolean <optional>
false 跳过调用list.remove回调.
Returns:
已成功从列表中删除的项目或项目数组.
Type
*

removeAll(skipCallbackopt) → {Phaser.Structs.List}

Since:
  • 3.0.0
移除所有项目.
Parameters:
Name Type Attributes Default Description
skipCallback boolean <optional>
false 跳过调用list.remove回调.
Returns:
此列表对象.
Type
Phaser.Structs.List

removeAt(index, skipCallbackopt) → {*}

Since:
  • 3.0.0
移除列表中给定位置的项目.
Parameters:
Name Type Attributes Default Description
index number