BIS fnc dynamicGroups: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| a3 |= Game name
|game1= arma3
|version1= 1.42


|1.42|= Game version
|gr1= Systems
____________________________________________________________________________________________


| Function that adds dynamic groups to the mission as seen in End Game. Function needs to be initialized on server and client. Clients can then use action TeamSwitch ("U" by default) to access the Dynamic Groups interface.
|descr= Function that adds dynamic groups to the mission as seen in End Game. Function needs to be initialized on server and client. Clients can then use action TeamSwitch ("U" by default) to access the Dynamic Groups interface.
|DESCRIPTION=
____________________________________________________________________________________________


| |SYNTAX=
|s1= [mode, params] call [[BIS_fnc_dynamicGroups]]


|p1= |= Parameter 1
|p1= mode: [[String]] - mode, can be:
* "Initialize" - Initializes dynamic groups on the server
* "Terminate" - Terminates dynamic groups on the server
* "InitializePlayer" - Does client side initialization
* "TerminatePlayer" - Does client side termination
* "IsInitialized" - Checks whether dynamic groups was initialized
* "RegisterGroup" - Registers a group
* "UnregisterGroup" - Unregisters a group
* "IsGroupRegistered" - Whether a group was already registered or not
* "SetName" - Sets the name of the group, in future, will also update GroupId of the group
* "SetPrivateState" - Set the private state of a group
* "SwitchLeader" - Switches the leader of given group to the given player
* "AddGroupMember" - Add a group member to group
* "RemoveGroupMember" - Switches a player from one group to another
* "KickPlayer" - Kicks a player from group, player wont be able to join the group unless invited or is unkicked using UnKickPlayer
* "UnKickPlayer" - Unkicks a player from a group
* "WasPlayerKickedFrom" - Whether given player was kicked from given group
* "GetAllGroups" - Returns all registered and valid groups


|p2= |= Parameter 2
|p2= params: [[Array]] - parameter changes according to {{hl|mode}}. Check the function in the Functions Viewer for detailed information


| |RETURNVALUE=
|r1= [[Nothing]]
____________________________________________________________________________________________
 
|x1= <code>["Initialize"] [[call]] [[BIS_fnc_dynamicGroups]];//Exec on Server</code> |= Example 1
|x2= <code><nowiki>["InitializePlayer", [</nowiki>[[player]]<nowiki>]]</nowiki> [[call]] [[BIS_fnc_dynamicGroups]];//Exec on client</code> |= Example 2
____________________________________________________________________________________________


|[[Dynamic Groups]]|SEEALSO=
|x1= <sqf>["Initialize"] call BIS_fnc_dynamicGroups; // exec on Server</sqf>


|x2= <sqf>["InitializePlayer", [player]] call BIS_fnc_dynamicGroups; // exec on client</sqf>
|seealso= [[Dynamic Groups]]
}}
}}
<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:{{Name|arma3}}: Functions|{{uc:halt}}]]
[[Category:Functions|{{uc:halt}}]]

Latest revision as of 17:12, 13 July 2022

Arma 3 logo black.png1.42
Hover & click on the images for description

Description

Description:
Function that adds dynamic groups to the mission as seen in End Game. Function needs to be initialized on server and client. Clients can then use action TeamSwitch ("U" by default) to access the Dynamic Groups interface.
Execution:
call
Groups:
Systems

Syntax

Syntax:
[mode, params] call BIS_fnc_dynamicGroups
Parameters:
mode: String - mode, can be:
  • "Initialize" - Initializes dynamic groups on the server
  • "Terminate" - Terminates dynamic groups on the server
  • "InitializePlayer" - Does client side initialization
  • "TerminatePlayer" - Does client side termination
  • "IsInitialized" - Checks whether dynamic groups was initialized
  • "RegisterGroup" - Registers a group
  • "UnregisterGroup" - Unregisters a group
  • "IsGroupRegistered" - Whether a group was already registered or not
  • "SetName" - Sets the name of the group, in future, will also update GroupId of the group
  • "SetPrivateState" - Set the private state of a group
  • "SwitchLeader" - Switches the leader of given group to the given player
  • "AddGroupMember" - Add a group member to group
  • "RemoveGroupMember" - Switches a player from one group to another
  • "KickPlayer" - Kicks a player from group, player wont be able to join the group unless invited or is unkicked using UnKickPlayer
  • "UnKickPlayer" - Unkicks a player from a group
  • "WasPlayerKickedFrom" - Whether given player was kicked from given group
  • "GetAllGroups" - Returns all registered and valid groups
params: Array - parameter changes according to mode. Check the function in the Functions Viewer for detailed information
Return Value:
Nothing

Examples

Example 1:
["Initialize"] call BIS_fnc_dynamicGroups; // exec on Server
Example 2:
["InitializePlayer", [player]] call BIS_fnc_dynamicGroups; // exec on client

Additional Information

See also:
Dynamic Groups

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_dynamicGroups&oldid=327978"