BIS fnc showRespawnMenuDisableItem: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added UI vars for list types)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(42 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.60


|1.60|= Game version
|gr1= Respawn


|eff= global |=
|eff= global
____________________________________________________________________________________________


| Limits respawn loadout or role for [[Arma 3 Respawn: New Respawn Screen|new respawn screen]].
|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.
* 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 the limit definition for role is called multiple times with different numbers, then the highest number is used.  
|= Description
* If disabling a position then respawnReference must be supplied
____________________________________________________________________________________________


| [mode, uiControl, item, message] call [[BIS_fnc_showRespawnMenuDisableItem]]; |= Syntax
|s1= [mode, uiControl, listboxItem, message, respawnReference] call [[BIS_fnc_showRespawnMenuDisableItem]]


|p1= '''mode''': [[String]] - Available options are ''disable'', ''enable'' and ''state''
|p1= '''mode''': [[String]] - available options are ''disable'', ''enable'' and ''state''
|p2= '''uiControl''': [[Control]] - List in which item should be disabled/enabled
|p2= '''uiControl''': [[Control]] - list in which item should be disabled/enabled
*BIS_RscRespawnControlsMap_ctrlLocList
*BIS_RscRespawnControlsMap_ctrlLocList
*BIS_RscRespawnControlsMap_ctrlRoleList
*BIS_RscRespawnControlsMap_ctrlRoleList
*BIS_RscRespawnControlsMap_ctrlComboLoadout
*BIS_RscRespawnControlsMap_ctrlComboLoadout
|p3= '''item''': [[Number]] or [[String]] - Index or name of item in the list
|p3= '''listboxItem''': [[Number]] or [[String]] - index or name of item in the respawn loadout/role/position listbox
|p4= '''message''': [[String]] - (Optional) Message shown when disabled item is selected
|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]]


| |= Return value
|r1= [[Nothing]]
____________________________________________________________________________________________
 
|x1= <code><nowiki>[</nowiki>"disable",uiNamespace getVariable "BIS_RscRespawnControlsMap_ctrlRoleList",2,"Restricted for this part of mission!"] [[call]] [[BIS_fnc_showRespawnMenuDisableItem]];</code> |=
____________________________________________________________________________________________


| [[BIS_fnc_addRespawnInventory]], [[BIS_fnc_addRespawnPosition]], [[Arma 3 Respawn: New Respawn Screen]] |= See also
|x1= <sqf>[
"disable",
uiNamespace getVariable "BIS_RscRespawnControlsMap_ctrlLocList",
2,
"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:addRespawnInventory}}]]
[[Category:Functions|{{uc:addRespawnInventory}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:addRespawnInventory}}]]

Latest revision as of 15:47, 8 November 2023

Arma 3 logo black.png1.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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_showRespawnMenuDisableItem&oldid=349083"