BIS fnc errorParamsType: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(Fixed examples, enhanced parameters)
Line 13: Line 13:
| [value, method, expected] call [[BIS_fnc_errorParamsType]] |Syntax=
| [value, method, expected] call [[BIS_fnc_errorParamsType]] |Syntax=


|p1= value: [[Anything]] - (Optional, default [[nil]]) value received |Parameter 1=
|p1= '''value''' (Optional, default: [[nil]]): [[Anything]] - Value received. |Parameter 1=


|p2= method: [[String]] - (Optional, default "") validation method, can be one of:
|p2= '''method''' (Optional, default: ""): [[String]] - Validation method, can be one of:
* "isEqualType"
* "isEqualType"
* "isEqualTypeArray"
* "isEqualTypeArray"
Line 22: Line 22:
* "isEqualTypeParams" |Parameter 2=
* "isEqualTypeParams" |Parameter 2=


|p3= expected: [[Anything]] - (Optional, default [[nil]]) - expected type |Parameter 3=
|p3= '''expected''' (Optional, default: [[nil]]): [[Anything]] - Expected type. |Parameter 3=


| [[Nothing]] |Return value=
| [[Nothing]] |Return value=


|x1= <code>{{cc|Show error and abort if input is not of type ARRAY}}
|x1= <code>{{cc|Show error and abort if input is not of type ARRAY:}}
[[if]] !([[_this]] [[isEqualType]] []) [[exitWith]] { [<nowiki/>[[_this]], "isEqualType", []] [[call]] [[BIS_fnc_errorParamsType]] };</code> |Example 1=
[[if]] !([[_this]] [[isEqualType]] []) [[exitWith]] { [<nowiki/>[[_this]], "isEqualType", []] [[call]] [[BIS_fnc_errorParamsType]]; };</code> |EXAMPLE1=


|x2= <code>{{cc|Show error and abort if array input is not in format [SCALAR, STRING, BOOL]}}
|x2= <code>{{cc|Show error and abort if array input is not in format [SCALAR, STRING, BOOL]:}}
[[if]] !([[_this]] [[isEqualTypeArray]] [0, "", [[true]]]) [[exitWith]] { [<nowiki/>[[_this]], "isEqualTypeArray", [0, "", [[true]]]] [[call]] [[BIS_fnc_errorParamsType]] };</code> |Example 2=
[[if]] !([[_this]] [[isEqualTypeArray]] [0, "", [[true]]]) [[exitWith]] { [<nowiki/>[[_this]], "isEqualTypeArray", [0, "", [[true]]]] [[call]] [[BIS_fnc_errorParamsType]]; };</code> |EXAMPLE2=


|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]] !([[_this]] [[isEqualTypeAll]] [[true]]) [[exitWith]] {[<nowiki/>[[_this]], "isEqualTypeAll", [[true]]] [[call]] [[BIS_fnc_errorParamsType]] };</code> |Example 3=
[[if]] !([[_this]] [[isEqualTypeAll]] [[true]]) [[exitWith]] { [<nowiki/>[[_this]], "isEqualTypeAll", [[true]]] [[call]] [[BIS_fnc_errorParamsType]]; };</code> |EXAMPLE3=
|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]] !([[_this]] [[isEqualTypeAny]] [[], [[objNull]]]) [[exitWith]] { [<nowiki/>[[_this]], "isEqualTypeAny", [[], [[objNull]]]] [[call]] [[BIS_fnc_errorParamsType]] };</code> |Example 4=
[[if]] !([[_this]] [[isEqualTypeAny]] <nowiki>[</nowiki>[], [[objNull]]]) [[exitWith]] { <nowiki>[</nowiki>[[_this]], "isEqualTypeAny", [[], [[objNull]]]] [[call]] [[BIS_fnc_errorParamsType]]; };</code> |EXAMPLE4=


|x5= <code>{{cc|Show error and abort if input is neither of type ARRAY nor array in format [SCALAR, ARRAY, <ANYTHING>, OBJECT....]}}
|x5= <code>{{cc|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]] { [<nowiki/>[[_this]], "isEqualTypeParams", [0, [], [[nil]], [[objNull]]]] [[call]] [[BIS_fnc_errorParamsType]]};</code> |Example 5=
[[if]] !([[_this]] [[isEqualTypeParams]] [0, [], [[nil]], [[objNull]]]) [[exitWith]] { <nowiki>[</nowiki>[[_this]], "isEqualTypeParams", [0, [], [[nil]], [[objNull]]]] [[call]] [[BIS_fnc_errorParamsType]]; };</code> |EXAMPLE5=


| [[BIS_fnc_error]] |See also=
| [[BIS_fnc_error]] |See also=
}}
}}

Revision as of 02:57, 6 January 2021

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 (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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_errorParamsType&oldid=184043"