isEqualTypeParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(see also)
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(45 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3dev |= Game name
|game1= arma3
|version1= 1.54


|1.53|= Game version
|gr1= Variables


____________________________________________________________________________________________
|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:
 
| 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 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
* 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
* [[nil]] could be used in template type array as a wild card to allow any type match
|= Description
____________________________________________________________________________________________


| input '''isEqualTypeParams''' template |= Syntax
|s1= input [[isEqualTypeParams]]  template
 
|p1= input: [[Anything]] - could be value of any type, but only type [[Array]] will be validated


|p1= input: [[Anything]] - could be value of any type, but only type [[Array]] will be validated |= Parameter 1
|p2= template: [[Array]] - array of expected types
|p2= template: [[Array]] - array of expected types |= Parameter 2


| [[Boolean]] |= Return value
|r1= [[Boolean]]
____________________________________________________________________________________________
 
|x1= <code>[1,2,[[player]],"10"] [[isEqualTypeParams]] [0,0,[[objNull]],""]; //true
123 [[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> |= Example 1


____________________________________________________________________________________________
|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>


|[[isEqualTypeAll]], [[isEqualTypeAny]], [[isEqualType]], [[isEqualTypeArray]], [[param]], [[params]], [[isEqualTo]], [[typeName]]|= See also
|x2= <sqf>
// These all return false
123 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]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:42, 3 September 2024

Arma 3 logo black.png1.54
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
Retrieved from "https://community.bistudio.com/wiki?title=isEqualTypeParams&oldid=369267"