Array

.Utils. Array

Namespaces

Matrix

Methods

(static) Add(array, item, limitopt, callbackopt, contextopt) → {array}

Since:
  • 3.4.0
将给定项或项数组添加到数组中. 每个项目在数组中必须是唯一的. 数组被就地修改并返回. 您可以选择指定数组最大大小的限制.如果物品的数量 add将使数组长度超过该限制,一旦达到该限制,它将停止添加. 您可以选择为每个成功添加到数组中的项指定一个要调用的回调.
Parameters:
Name Type Attributes Description
array array 要添加到的数组.
item any | Array.<any> 要添加到数组中的项或项数组.每个项目在数组中必须是唯一的.
limit number <optional>
可选限制,限制数组的大小.
callback function <optional>
为每个成功添加到数组中的项调用的回调.
context object <optional>
调用回调的上下文.
Returns:
输入数组.
Type
array

(static) AddAt(array, item, indexopt, limitopt, callbackopt, contextopt) → {array}

Since:
  • 3.4.0
从指定的索引处开始,将给定项或项数组添加到数组中. 每个项目在数组中必须是唯一的. 数组中的现有元素上移. 数组被就地修改并返回. 您可以选择指定数组最大大小的限制.如果物品的数量 add将使数组长度超过该限制,一旦达到该限制,它将停止添加. 您可以选择为每个成功添加到数组中的项指定一个要调用的回调.
Parameters:
Name Type Attributes Default Description
array array 要添加到的数组.
item any | Array.<any> 要添加到数组中的项或项数组.
index number <optional>
0 数组中要插入项的索引.
limit number <optional>
可选限制,限制数组的大小.
callback function <optional>
为每个成功添加到数组中的项调用的回调.
context object <optional>
调用回调的上下文.
Returns:
输入数组.
Type
array

(static) BringToTop(array, item) → {*}

Since:
  • 3.4.0
将给定元素移动到数组的顶部. 数组被就地修改.
Parameters:
Name Type Description
array array 数组.
item * 要移动的元素.
Returns:
被移动的元素.
Type
*

(static) CountAllMatching(array, property, value, startIndexopt, endIndexopt) → {number}

Since:
  • 3.4.0
返回数组中具有与给定值匹配的属性的元素总数.
Parameters:
Name Type Attributes Description
array array 要搜索的数组.
property string 要在每个数组元素上测试的属性.
value * 测试属性所依据的值.必须通过严格的( `===` )比较检查.
startIndex number <optional>
可选的开始索引,用于搜索.
endIndex number <optional>
要搜索的可选结束索引.
Returns:
属性与给定值匹配的元素总数.
Type
number

(static) Each(array, callback, context, …argsopt) → {array}

Since:
  • 3.4.0
将数组中的每个元素传递给给定的回调.
Parameters:
Name Type Attributes Description
array array 要搜索的数组.
callback function 为数组中的每一项调用的回调.
context object 调用回调的上下文.
args * <optional>
<repeatable>
将传递给回调的附加参数,在当前数组项之后.
Returns:
输入数组.
Type
array

(static) EachInRange(array, callback, context, startIndex, endIndex, …argsopt) → {array}

Since:
  • 3.4.0
将数组中起始索引和结束索引之间的每个元素传递给给定的回调.
Parameters:
Name Type Attributes Description
array array 要搜索的数组.
callback function 为数组中的每一项调用的回调.
context object 调用回调的上下文.
startIndex number 要搜索的起始索引.
endIndex number 要搜索的结束索引.
args * <optional>
<repeatable>
将传递给回调的附加参数,在子级之后.
Returns:
输入数组.
Type
array

(static) FindClosestInSorted(value, array, keyopt) → {number|any}

Since:
  • 3.0.0
在预先排序的数组中搜索给定数字的封闭值. 如果给定了 `key` 参数,它将假设数组包含所有具有所需 `key` 属性名的对象, 并将检查那些与给定数字最接近的值.
Parameters:
Name Type Attributes Description
value number 要在数组中搜索的值.
array array 要搜索的数组,必须对其进行排序.
key string <optional>
可选的属性键.如果指定,将根据值检查数组元素属性.
Returns:
在数组中找到的最接近的值,或者如果给定了 `key` ,则是具有匹配属性值的最接近的对象.
Type
number | any

(static) GetAll(array, propertyopt, valueopt, startIndexopt, endIndexopt) → {array}

Since:
  • 3.4.0
返回数组中的所有元素. 您可以选择使用 `property` 和 `value` 参数指定匹配条件. 例如: `getAll(`visible` ,true)`将只返回设置了可见属性的元素. 您可以选择指定开始和结束索引.例如,如果数组有100个元素, 如果将 `startIndex` 设置为0,将 `endIndex` 设置为50,它将只返回匹配项 前50个元素.
Parameters:
Name Type Attributes Description
array array 要搜索的数组.
property string <optional>
要在每个数组元素上测试的属性.
value * <optional>
测试属性所依据的值.必须通过严格的( `===` )比较检查.
startIndex number <optional>
可选的开始索引,用于搜索.
endIndex number <optional>
要搜索的可选结束索引.
Returns:
数组中所有匹配的元素.
Type
array

(static) GetFirst(array, propertyopt, valueopt, startIndexopt, endIndexopt) → {object}

Since:
  • 3.4.0
返回数组中的第一个元素. 您可以选择使用 `property` 和 `value` 参数指定匹配条件. 例如: `getAll(`visible` ,true)`将返回第一个设置了 `visible` 属性的元素. 您可以选择指定开始和结束索引.例如,如果数组有100个元素, 如果将 `startIndex` 设置为0,将 `endIndex` 设置为50,它将只搜索前50个元素.
Parameters:
Name Type Attributes Default Description
array array 要搜索的数组.
property string <optional>
要在每个数组元素上测试的属性.
value * <optional>
测试属性所依据的值.必须通过严格的( `===` )比较检查.
startIndex number <optional>
0 可选的开始索引,用于搜索.
endIndex number <optional>
array.length 一个可选的结束索引,用于搜索(但不包括)
Returns:
数组中的第一个匹配元素,如果在给定范围内找不到元素,则为 `null` .
Type
object

(static) GetRandom(array, startIndexopt, lengthopt) → {*}

Since:
  • 3.0.0
从数组中返回随机元素.
Parameters:
Name Type Attributes Default Description
array array 从中选择随机条目的数组.
startIndex number <optional>
0 可选的开始索引.
length number <optional>
array.length 可选长度,可供选择的元素总数(从开始索引).
Returns:
数组中的随机元素,如果在给定范围内找不到元素,则为 `null` .
Type
*

(static) MoveDown(array, item) → {array}

Since:
  • 3.4.0
将给定的数组元素在数组中下移一个位置. 数组被就地修改.
Parameters:
Name Type Description
array array 输入数组.
item * 要在数组中下移的元素.
Returns:
输入数组.
Type
array

(static) MoveTo(array, item, index) → {*}

Since:
  • 3.4.0
将数组中的元素移动到同一数组中的新位置. 数组被就地修改.
Parameters:
Name Type Description
array array 数组.
item * 要移动的元素.
index number 元素将被移动到的新索引.
Returns:
被移动的元素.
Type
*

(static) MoveUp(array, item) → {array}

Since:
  • 3.4.0
将给定的数组元素在数组中上移一个位置. 数组被就地修改.
Parameters:
Name Type Description
array array 输入数组.
item * 要在数组中上移的元素.
Returns:
输入数组.
Type
array

(static) NumberArray(start, end, prefixopt, suffixopt) → {Array.<number>|Array.<string>}

Since:
  • 3.0.0
创建一个数组,表示介于和之间(包括)的数字范围(通常为整数) 给定的 `start` 和 `end` 参数.例如: `var array = Phaser.Utils.Array.NumberArray(2, 4); // array = [2, 3, 4]` `var array = Phaser.Utils.Array.NumberArray(0, 9); // array = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]` `var array = Phaser.Utils.Array.NumberArray(8, 2); // array = [8, 7, 6, 5, 4, 3, 2]` 这相当于 `Phaser.utils.array.numberarraystep(start,end,1)` . 您可以选择提供前缀和/或后缀字符串.如果给定,数组将包含 字符串,而不是整数.例如: `var array = Phaser.Utils.Array.NumberArray(1, 4, 'Level '); // array = ["Level 1", "Level 2", "Level 3", "Level 4"]` `var array = Phaser.Utils.Array.NumberArray(5, 7, 'HD-', '.png'); // array = ["HD-5.png", "HD-6.png", "HD-7.png"]`
Parameters:
Name Type Attributes Description
start number 数组的最小值.
end number 数组包含的最大值.
prefix string <optional>
放在数字前面的可选前缀.如果提供,数组将包含字符串,而不是整数.
suffix string <