array_contains

此函数用于检查给定值是否存在于数组中或数组的一部分中。如果该值存在,则返回 true 如果不存在,则返回 false

提示 要检查数组是否不仅包含值,而且还包含满足特定条件的值,请使用 array_any

 

语法:

array_contains(array, value, [offset], [length]);

参数类型描述
arrayArray要在其中查找值的数组
valueAny要在数组中查找的值
offsetReal可选 数组中的偏移量或起始索引。设置负值将从数组的末尾开始计数。然后,起始索引将是 array_length(array)+offset。请参阅:偏移量和长度
lengthReal可选 要遍历的元素数。负值将向后遍历数组(即以索引的降序,例如 2、1、0 而不是 2、3、4)。请参阅: 偏移量和长度

 

返回:

Boolean

 

示例1:

var _digits_decimal = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
var _contains = array_contains(_digits_decimal, 3);
show_debug_message("The array contains the digit 3: {0}", _contains);

上面的代码首先定义一个数组 _digits_decimal,该数组包含从 0 到 9 的十进制数字。然后它调用 array_contains 以检查值 3 是否在数组中。最后,它显示带有结果的调试消息。

 

示例2:数组的数组

var _a = [0, 1, 2];
var _b = _a;
var _array_of_arrays = 
[
    [
        "this", "that", "another thing"
    ],
    _a
];
show_debug_message(array_contains(_array_of_arrays, _a));
show_debug_message(array_contains(_array_of_arrays, _b));
show_debug_message(array_contains(_array_of_arrays, [0, 1, 2]));
show_debug_message(array_contains(_array_of_arrays, ["this", "that", "another thing"]));

上面的代码首先定义了三个临时变量:数组 _a、引用 _a 的变量 _b 和数组 _array_of_arrays

然后,它会显示四条调试消息,结果是在四种不同的情况下调用 array_contains 。 _array_of_arrays 包含 _a,因为它已作为元素添加到其中。它还包含 _b ,因为 _b 引用了 _a。其余的检查返回 false ,因为即使数组包含相同的值,它们也不是相同的数组。