isEqualTypeParams: Difference between revisions

Latest revision as of 19:42, 3 September 2024

Hover & click on the images for description

Description

Description:

Compares types of all elements of input array to types of all elements of template array. Similar to isEqualTypeArray however this command is designed for fast validation of functions params, so there are differences:

Input can be anything but will be expected to be an Array, otherwise false is returned
Input array can be longer but not shorter than template array, will return false if shorter
nil could be used in template type array as a wild card to allow any type match

Groups:

Variables

Syntax

Syntax:: input isEqualTypeParams template
Parameters:: input: Anything - could be value of any type, but only type Array will be validated
: template: Array - array of expected types
Return Value:: Boolean

Examples

Example 1:: // These all return true [1,2,player,"10"] isEqualTypeParams [0,0,objNull,""]; [1,2,player,"10",true] isEqualTypeParams [0,0,nil,""]; [1,2,getPos player,"10",true] isEqualTypeParams [0,0,nil,""];
Example 2:: // These all return false 123 isEqualTypeParams [0,0,objNull,""]; [] isEqualTypeParams [0,0,objNull,""]; [1,2,player] isEqualTypeParams [0,0,objNull,""];

Additional Information

See also:: isEqualTypeAll isEqualTypeAny isEqualType isEqualTypeArray param params isEqualTo typeName

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

@@ Line 1: / Line 1: @@
 {{RV|type=command
-| arma3
+|game1= arma3
+|version1= 1.54
-|1.54
 |gr1= Variables
-| Compares types of all elements of input array to types of all elements of template array. Similar to [[isEqualTypeArray]] however this command is designed for fast validation of functions params, so there are differences:
+|descr= Compares types of all elements of input array to types of all elements of template array. Similar to [[isEqualTypeArray]] however this command is designed for fast validation of functions params, so there are differences:
 * Input can be anything but will be expected to be an [[Array]], otherwise [[false]] is returned
 * Input array can be longer but not shorter than template array, will return [[false]] if shorter
 * [[nil]] could be used in template type array as a wild card to allow any type match
-| input '''isEqualTypeParams''' template
+|s1= input [[isEqualTypeParams]]  template
 |p1= input: [[Anything]] - could be value of any type, but only type [[Array]] will be validated
 |p2= template: [[Array]] - array of expected types
-| [[Boolean]]
+|r1= [[Boolean]]
-|x1= <code>[1,2,[[player]],"10"] [[isEqualTypeParams]] [0,0,[[objNull]],""]; //true
-[[isEqualTypeParams]] [0,0,[[objNull]],""]; //false
-[] [[isEqualTypeParams]] [0,0,[[objNull]],""]; //false
-[1,2,[[player]]] [[isEqualTypeParams]] [0,0,[[objNull]],""]; //false
-[1,2,[[player]],"10",[[true]]] [[isEqualTypeParams]] [0,0,[[nil]],""]; //true
-[1,2,[[getPos]] [[player]],"10",[[true]]] [[isEqualTypeParams]] [0,0,[[nil]],""]; //true</code>
-|[[isEqualTypeAll]], [[isEqualTypeAny]], [[isEqualType]], [[isEqualTypeArray]], [[param]], [[params]], [[isEqualTo]], [[typeName]]
+|x1= <sqf>
-}}
+// These all return true
+[1,2,player,"10"] isEqualTypeParams [0,0,objNull,""];
+[1,2,player,"10",true] isEqualTypeParams [0,0,nil,""];
+[1,2,getPos player,"10",true] isEqualTypeParams [0,0,nil,""];
+</sqf>
+|x2= <sqf>
+// These all return false
+isEqualTypeParams [0,0,objNull,""];
+[] isEqualTypeParams [0,0,objNull,""];
+[1,2,player] isEqualTypeParams [0,0,objNull,""];
+</sqf>
+|seealso= [[isEqualTypeAll]] [[isEqualTypeAny]] [[isEqualType]] [[isEqualTypeArray]] [[param]] [[params]] [[isEqualTo]] [[typeName]]
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
+}}
-{{GameCategory|arma3|New Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}