BIS fnc errorParamsType: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (infobox to template)
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *E([a-z])" to "$1 - e$2")
 
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Diagnostic


<!---|arg= local |Multiplayer Arguments=--->
|eff= local


<!---|eff= local |Multiplayer Effects=--->
|descr= Displays a parameter type error message (using [[BIS_fnc_error]]) explaining the problem.


| <pre>/*
|s1= [value, method, expected] call [[BIS_fnc_errorParamsType]]
Author: Killzone_Kid


Description:
|p1= '''value''': [[Anything]] - (Optional, default [[nil]]) value received.
Displays params type error message explaining the problem


Parameter(s):
|p2= '''method''': [[String]] - (Optional, default "") validation method, can be one of:
0: ANY - actual input
* "isEqualType"
1: STRING - validation method - the name of type validation command used:
* "isEqualTypeArray"
* "isEqualType"
* "isEqualTypeAll"
* "isEqualTypeArray"
* "isEqualTypeAny"
* "isEqualTypeAll"
* "isEqualTypeParams"
* "isEqualTypeAny"
* "isEqualTypeParams"
2: ANY - expected input type format


Returns:
|p3= '''expected''' (Optional, default: [[nil]]): [[Anything]] - expected type.
NOTHING
Example1:
//Show error and abort if input is not of type ARRAY
if !(_this isEqualType []) exitWith {[_this,"isEqualType",[]] call BIS_fnc_errorParamsType};
Example2:
//Show error and abort if array input is not in format [SCALAR,STRING,BOOL]
if !(_this isEqualTypeArray [0,"",true]) exitWith {[_this,"isEqualTypeArray",[0,"",true]] call BIS_fnc_errorParamsType};
Example3:
//Show error and abort if array input is not in format [BOOL,BOOL,BOOL....]
if !(_this isEqualTypeAll true) exitWith {[_this,"isEqualTypeAll",true] call BIS_fnc_errorParamsType};
Example4:
//Show error and abort if input is neither ARRAY nor OBJECT
if !(_this isEqualTypeAny [[],objNull]) exitWith {[_this,"isEqualTypeAny",[[],objNull]] call BIS_fnc_errorParamsType};
Example5:
//Show error and abort if input is neither of type ARRAY nor array in format [SCALAR,ARRAY,<ANYTHING>,OBJECT....]
if !(_this isEqualTypeParams [0,[],nil,objNull]) exitWith {[_this,"isEqualTypeParams",[0,[],nil,objNull]] call BIS_fnc_errorParamsType};
*/</pre>{{placeholder}}<!-- Remove this after fill-in --> |Description=


|[] call [[BIS_fnc_errorParamsType]]|Syntax=
|r1= [[Nothing]]


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|x1= <sqf>
// show error and abort if input is not of type ARRAY:
if !(_this isEqualType []) exitWith { [_this, "isEqualType", []] call BIS_fnc_errorParamsType; };
</sqf>


|Datatype - description|Return value=
|x2= <sqf>
// show error and abort if array input is not in format [SCALAR, STRING, BOOL]:
if !(_this isEqualTypeArray [0, "", true]) exitWith { [_this, "isEqualTypeArray", [0, "", true]] call BIS_fnc_errorParamsType; };
</sqf>


|x1= <code></code>|Example 1=
|x3= <sqf>
// show error and abort if array input is not in format [BOOL, BOOL, BOOL, ...]:
if !(_this isEqualTypeAll true) exitWith { [_this, "isEqualTypeAll", true] call BIS_fnc_errorParamsType; };
</sqf>


| |See also=
|x4= <sqf>
// show error and abort if input is neither ARRAY nor OBJECT:
if !(_this isEqualTypeAny [[], objNull]) exitWith { [_this, "isEqualTypeAny", [[], objNull]] call BIS_fnc_errorParamsType; };
</sqf>
 
|x5= <sqf>
// show error and abort if input is neither of type ARRAY nor array in format [SCALAR, ARRAY, <ANYTHING>, OBJECT]:
if !(_this isEqualTypeParams [0, [], nil, objNull]) exitWith { [_this, "isEqualTypeParams", [0, [], nil, objNull]] call BIS_fnc_errorParamsType; };
</sqf>
 
|seealso= [[BIS_fnc_error]]
}}
}}
[[Category:Function Group: Debug|{{uc:errorParamsType}}]]
[[Category:Functions|{{uc:errorParamsType}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:errorParamsType}}]]

Latest revision as of 15:06, 8 November 2023

Arma 3 logo black.png1.00
LELocal
Hover & click on the images for description

Description

Description:
Displays a parameter type error message (using BIS_fnc_error) explaining the problem.
Execution:
call
Groups:
Diagnostic

Syntax

Syntax:
[value, method, expected] call BIS_fnc_errorParamsType
Parameters:
value: Anything - (Optional, default nil) value received.
method: String - (Optional, default "") validation method, can be one of:
  • "isEqualType"
  • "isEqualTypeArray"
  • "isEqualTypeAll"
  • "isEqualTypeAny"
  • "isEqualTypeParams"
expected (Optional, default: nil): Anything - expected type.
Return Value:
Nothing

Examples

Example 1:
// show error and abort if input is not of type ARRAY: if !(_this isEqualType []) exitWith { [_this, "isEqualType", []] call BIS_fnc_errorParamsType; };
Example 2:
// show error and abort if array input is not in format [SCALAR, STRING, BOOL]: if !(_this isEqualTypeArray [0, "", true]) exitWith { [_this, "isEqualTypeArray", [0, "", true]] call BIS_fnc_errorParamsType; };
Example 3:
// show error and abort if array input is not in format [BOOL, BOOL, BOOL, ...]: if !(_this isEqualTypeAll true) exitWith { [_this, "isEqualTypeAll", true] call BIS_fnc_errorParamsType; };
Example 4:
// show error and abort if input is neither ARRAY nor OBJECT: if !(_this isEqualTypeAny [[], objNull]) exitWith { [_this, "isEqualTypeAny", [[], objNull]] call BIS_fnc_errorParamsType; };
Example 5:
// show error and abort if input is neither of type ARRAY nor array in format [SCALAR, ARRAY, <ANYTHING>, OBJECT]: if !(_this isEqualTypeParams [0, [], nil, objNull]) exitWith { [_this, "isEqualTypeParams", [0, [], nil, objNull]] call BIS_fnc_errorParamsType; };

Additional Information

See also:
BIS_fnc_error

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=BIS_fnc_errorParamsType&oldid=348544"