BIS fnc objectSide: Difference between revisions
Jump to navigation
Jump to search
m (Removed additional space) |
m (template:command argument fix) |
||
| Line 8: | Line 8: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Returns object side as defined in config (i.e. not affected by dynamic changing like rating) |= | | Returns object side as defined in config (i.e. not affected by dynamic changing like rating) |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [target, boolean] call [[BIS_fnc_objectSide]] |= | | [target, boolean] call [[BIS_fnc_objectSide]] |SYNTAX= | ||
|p1= target: [[Object]] - the object to be tested |= | |p1= target: [[Object]] - the object to be tested |PARAMETER1= | ||
|p2= boolean: [[Boolean]] (optional) - false (default) to return actual object side, true to return the default config value |= | |p2= boolean: [[Boolean]] (optional) - false (default) to return actual object side, true to return the default config value |PARAMETER2= | ||
| [[Side]] |= | | [[Side]] |RETURNVALUE= | ||
|s2= target call [[BIS_fnc_objectSide]] |= Alternative Syntax | |s2= target call [[BIS_fnc_objectSide]] |= Alternative Syntax | ||
| Line 27: | Line 27: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_realVehicleSide = <nowiki>[</nowiki>[[vehicle]] [[player]], [[true]]] [[call]] [[BIS_fnc_objectSide]];</code> |= | |x1= <code>_realVehicleSide = <nowiki>[</nowiki>[[vehicle]] [[player]], [[true]]] [[call]] [[BIS_fnc_objectSide]];</code> |EXAMPLE1= | ||
|x2= <code>_unknownSide = <nowiki>[</nowiki>'''[[objNull]]''', [[false]]] [[call]] [[BIS_fnc_objectSide]]; {{codecomment|// will return [[sideUnknown]]}} | |x2= <code>_unknownSide = <nowiki>[</nowiki>'''[[objNull]]''', [[false]]] [[call]] [[BIS_fnc_objectSide]]; {{codecomment|// will return [[sideUnknown]]}} | ||
_eastSide = <nowiki>[</nowiki>'''[[objNull]]''', [[true]]] [[call]] [[BIS_fnc_objectSide]]; {{codecomment|// will return [[east]]}}</code> |= | _eastSide = <nowiki>[</nowiki>'''[[objNull]]''', [[true]]] [[call]] [[BIS_fnc_objectSide]]; {{codecomment|// will return [[east]]}}</code> |EXAMPLE2= | ||
|x3= <code>{{codecomment|// same results}} | |x3= <code>{{codecomment|// same results}} | ||
_result1 = myVehicle [[call]] [[BIS_fnc_objectSide]]; | _result1 = myVehicle [[call]] [[BIS_fnc_objectSide]]; | ||
_result2 = [myVehicle] [[call]] [[BIS_fnc_objectSide]]; | _result2 = [myVehicle] [[call]] [[BIS_fnc_objectSide]]; | ||
_result3 = [myVehicle, false] [[call]] [[BIS_fnc_objectSide]];</code> |= | _result3 = [myVehicle, false] [[call]] [[BIS_fnc_objectSide]];</code> |EXAMPLE3= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[side]], [[CfgVehicles_Config_Reference#side|CfgVehicles config side value]], [[Side]], [[playerSide]], [[west]], [[east]], [[resistance]], [[civilian]], [[sideLogic]], [[sideFriendly]], [[sideEnemy]], [[sideUnknown]], [[sideEmpty]], [[sideAmbientLife]], [[Side relations]], [[BIS_fnc_sideID]] |= | | [[side]], [[CfgVehicles_Config_Reference#side|CfgVehicles config side value]], [[Side]], [[playerSide]], [[west]], [[east]], [[resistance]], [[civilian]], [[sideLogic]], [[sideFriendly]], [[sideEnemy]], [[sideUnknown]], [[sideEmpty]], [[sideAmbientLife]], [[Side relations]], [[BIS_fnc_sideID]] |SEEALSO= | ||
}} | }} | ||
Revision as of 15:32, 7 April 2019
Description
- Description:
- Returns object side as defined in config (i.e. not affected by dynamic changing like rating)
- Execution:
- call
- Groups:
- Uncategorised
Syntax
- Syntax:
- [target, boolean] call BIS_fnc_objectSide
- Parameters:
- target: Object - the object to be tested
- boolean: Boolean (optional) - false (default) to return actual object side, true to return the default config value
- Return Value:
- Side
Alternative Syntax
- Syntax:
- target call BIS_fnc_objectSide
- Parameters:
- target: Object - the object to be tested. This syntax is equal to calling the method with false as a second parameter.
- Return Value:
- Side
Examples
- Example 1:
_realVehicleSide = [vehicle player, true] call BIS_fnc_objectSide;- Example 2:
_unknownSide = [objNull, false] call BIS_fnc_objectSide; // will return sideUnknown _eastSide = [objNull, true] call BIS_fnc_objectSide; // will return east- Example 3:
// same results _result1 = myVehicle call BIS_fnc_objectSide; _result2 = [myVehicle] call BIS_fnc_objectSide; _result3 = [myVehicle, false] call BIS_fnc_objectSide;
Additional Information
- See also:
- sideCfgVehicles config side valueSideplayerSidewesteastresistanceciviliansideLogicsideFriendlysideEnemysideUnknownsideEmptysideAmbientLifeSide relationsBIS_fnc_sideID
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