BIS fnc errorParamsType: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "| arma3 |1.00 " to "|game1= arma3 |version1= 1.00 ") |
Lou Montana (talk | contribs) m (Text replacement - " |" to " |") |
||
Line 33: | Line 33: | ||
|x3= <code>{{cc|Show error and abort if array input is not in format [BOOL, BOOL, BOOL, ...]:}} | |x3= <code>{{cc|Show error and abort if array input is not in format [BOOL, BOOL, BOOL, ...]:}} | ||
[[if]] !([[Magic Variables#this|_this]] [[isEqualTypeAll]] [[true]]) [[exitWith]] { [<nowiki/>[[Magic Variables#this|_this]], "isEqualTypeAll", [[true]]] [[call]] [[BIS_fnc_errorParamsType]]; };</code> | [[if]] !([[Magic Variables#this|_this]] [[isEqualTypeAll]] [[true]]) [[exitWith]] { [<nowiki/>[[Magic Variables#this|_this]], "isEqualTypeAll", [[true]]] [[call]] [[BIS_fnc_errorParamsType]]; };</code> | ||
|x4= <code>{{cc|Show error and abort if input is neither ARRAY nor OBJECT:}} | |x4= <code>{{cc|Show error and abort if input is neither ARRAY nor OBJECT:}} | ||
[[if]] !([[Magic Variables#this|_this]] [[isEqualTypeAny]] [<nowiki/>[], [[objNull]]]) [[exitWith]] { [<nowiki/>[[Magic Variables#this|_this]], "isEqualTypeAny", [[], [[objNull]]]] [[call]] [[BIS_fnc_errorParamsType]]; };</code> | [[if]] !([[Magic Variables#this|_this]] [[isEqualTypeAny]] [<nowiki/>[], [[objNull]]]) [[exitWith]] { [<nowiki/>[[Magic Variables#this|_this]], "isEqualTypeAny", [[], [[objNull]]]] [[call]] [[BIS_fnc_errorParamsType]]; };</code> |
Revision as of 10:47, 14 June 2021
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 (Optional, default: nil): Anything - Value received.
- method (Optional, default: ""): String - 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