BIS fnc errorParamsType: Difference between revisions
Jump to navigation
Jump to search
m (fixed game version) |
Lou Montana (talk | contribs) m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *E([a-z])" to "$1 - e$2") |
||
(24 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=function | ||
| arma3 | | |game1= arma3 | ||
|version1= 1.00 | |||
| | |gr1= Diagnostic | ||
|eff= local | |||
|descr= Displays a parameter type error message (using [[BIS_fnc_error]]) explaining the problem. | |||
| | |s1= [value, method, expected] call [[BIS_fnc_errorParamsType]] | ||
|p1= '''value''': [[Anything]] - (Optional, default [[nil]]) value received. | |||
|p2= '''method''': [[String]] - (Optional, default "") validation method, can be one of: | |||
* "isEqualType" | |||
* "isEqualTypeArray" | |||
* "isEqualTypeAll" | |||
* "isEqualTypeAny" | |||
* "isEqualTypeParams" | |||
|p3= '''expected''' (Optional, default: [[nil]]): [[Anything]] - expected type. | |||
| | |r1= [[Nothing]] | ||
| | |x1= <sqf> | ||
// show error and abort if input is not of type ARRAY: | |||
if !(_this isEqualType []) exitWith { [_this, "isEqualType", []] call BIS_fnc_errorParamsType; }; | |||
</sqf> | |||
| | |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> | |||
| | |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> | |||
| | | |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]] | |||
}} | }} | ||
Latest revision as of 15:06, 8 November 2023
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:
- Example 2:
- Example 3:
- Example 4:
- Example 5:
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