BIS fnc showRespawnMenuDisableItem: Difference between revisions

Latest revision as of 16:47, 8 November 2023

1.60

GEGlobal

Hover & click on the images for description

Description

Description:

Disables respawn loadout, role or position for Arma 3: Respawn.

Only role or only loadout can be limited at one moment, if there is limit for both, then only role uses limit.
If the limit definition for role is called multiple times with different numbers, then the highest number is used.
If disabling a position then respawnReference must be supplied

Execution:

call

Groups:

Respawn

Syntax

Syntax:

[mode, uiControl, listboxItem, message, respawnReference] call BIS_fnc_showRespawnMenuDisableItem

Parameters:

mode: String - available options are disable, enable and state

uiControl: Control - list in which item should be disabled/enabled

BIS_RscRespawnControlsMap_ctrlLocList
BIS_RscRespawnControlsMap_ctrlRoleList
BIS_RscRespawnControlsMap_ctrlComboLoadout

listboxItem: Number or String - index or name of item in the respawn loadout/role/position listbox

message: String - message shown when disabled item is selected, use "" for default message

respawnReference: String - reference to respawn position either Marker name or Object var name

Return Value:

Nothing

Examples

Example 1:: [ "disable", uiNamespace getVariable "BIS_RscRespawnControlsMap_ctrlLocList", 2, "Restricted for this part of mission!", myRespawnModule call BIS_fnc_objectVar ] call BIS_fnc_showRespawnMenuDisableItem;

Additional Information

See also:: BIS_fnc_addRespawnInventory BIS_fnc_addRespawnPosition Arma 3: Respawn

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.60
-| arma3 |= Game name
+|gr1= Respawn
-|1.00|= Game version
+|eff= global
-____________________________________________________________________________________________
-| ''N/A'' |= Description
+|descr= Disables respawn loadout, role or position for [[Arma 3: Respawn]].
-____________________________________________________________________________________________
+* Only role or only loadout can be limited at one moment, if there is limit for both, then only role uses limit.
+* If the limit definition for role is called multiple times with different numbers, then the highest number is used.
+* If disabling a position then respawnReference must be supplied
-| <!-- [] call [[BIS_fnc_showRespawnMenuDisableItem]]; --> |= Syntax
+|s1= [mode, uiControl, listboxItem, message, respawnReference] call [[BIS_fnc_showRespawnMenuDisableItem]]
-|p1= |= Parameter 1
-| |= Return value
+|p1= '''mode''': [[String]] - available options are ''disable'', ''enable'' and ''state''
-____________________________________________________________________________________________
+|p2= '''uiControl''': [[Control]] - list in which item should be disabled/enabled
+*BIS_RscRespawnControlsMap_ctrlLocList
+*BIS_RscRespawnControlsMap_ctrlRoleList
+*BIS_RscRespawnControlsMap_ctrlComboLoadout
+|p3= '''listboxItem''': [[Number]] or [[String]] - index or name of item in the respawn loadout/role/position listbox
+|p4= '''message''': [[String]] - message shown when disabled item is selected, use "" for default message
+|p5= '''respawnReference''': [[String]] - reference to respawn position either Marker name or [[vehicleVarName|Object var name]]
-|x1= <code></code> |=
+|r1= [[Nothing]]
-____________________________________________________________________________________________
-| |= See also
+|x1= <sqf>[
+	"disable",
+	uiNamespace getVariable "BIS_RscRespawnControlsMap_ctrlLocList",
+,
+	"Restricted for this part of mission!",
+	myRespawnModule call BIS_fnc_objectVar
+] call BIS_fnc_showRespawnMenuDisableItem;</sqf>
+|seealso= [[BIS_fnc_addRespawnInventory]] [[BIS_fnc_addRespawnPosition]] [[Arma 3: Respawn]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Respawn|{{uc:showRespawnMenuDisableItem}}]]
-[[Category:Functions|{{uc:showRespawnMenuDisableItem}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:showRespawnMenuDisableItem}}]]