This function checks if the given array (or a part of it) contains any or all of the given values.
The matchAll argument determines if all values should be present in the array (true) or if any one of the values will do (false).
The values array may contain duplicates. When matchAll is enabled, this allows you to check exactly how many occurrences of a value exist in the original array.
TIP To check if an array not just contains a value but rather contains a value that satisfies a certain condition, use array_any.
array_contains_ext(array, values, [matchAll], [offset], [length]);
| Argument | Type | Description |
|---|---|---|
| array | Array | The array in which to look for the values |
| values | Array | An array containing the values to look for. Add a value multiple times with the matchAll argument set to true to require that a value occurs multiple times (see Example 2). Order isn't taken into account, i.e. the values don't have to occur in the array in the order they're listed here. |
| matchAll | Boolean | OPTIONAL Whether all values should be present in the array (true) or any of the values will do (false). The default is false. |
| offset | Real | OPTIONAL The offset, or starting index, in the array. Defaults to 0. Setting a negative value will count from the end of the array. The starting index will then be array_length(array) + offset. See: Offset And Length |
| length | Real | OPTIONAL The number of elements to traverse. The default is array_length() - 1. A negative value will traverse the array backwards (i.e. in descending order of indices, e.g. 2, 1, 0 instead of 2, 3, 4). See: Offset And Length |
hand = ["1", "1", "4", "J", "J", "Q", "7", "10", "K", "8", "7", "8", "5"];
var _high_cards = ["A", "K", "Q", "J"];
var _any_high_cards = array_contains_ext(hand, _high_cards);
show_debug_message(_any_high_cards);
The above code first creates an array hand with 13 values. It then defines another array _high_cards that defines which are considered "high" cards. Next the hand array is checked for any of these using array_contains_ext and the result is stored in a temporary variable _any_high_cards. Finally a debug message shows the value of the variable _any_high_cards.
inputs = ["left", "right", "left", "left", "up", "down", "right"];
var _required_inputs = ["left", "left", "left"];
var _input_valid = array_contains_ext(inputs, _required_inputs, true);
show_debug_message(_input_valid);
The above code creates an array containing a sequence of inputs. Then it creates another array which contains the inputs that make the sequence valid (i.e. having only three occurrences of "left"). It then calls array_contains_ext to validate the inputs array, stores the result in a variable and prints it to the output log.