BIS_fnc_errorParamsType

From Bohemia Interactive Community
Revision as of 16:57, 11 October 2020 by R3vo (talk | contribs) (Text replacement - "|gr1 = Debug |GROUP1=" to "|gr1 = Diagnostic |GROUP1=")
Jump to navigation Jump to search
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: Anything - (Optional, default nil) - 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 4= |x5= // 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