BIS fnc dynamicGroups: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[[cC]ategory:\{\{Name\|arma3\}\}: [fF]unctions\|\{\{uc:[a-z A-Z_]*\}\}\]\]" to "")
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ :\\\-\/|()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
Line 37: Line 37:
|x2= <code><nowiki>["InitializePlayer", [</nowiki>[[player]]<nowiki>]]</nowiki> [[call]] [[BIS_fnc_dynamicGroups]];//Exec on client</code>
|x2= <code><nowiki>["InitializePlayer", [</nowiki>[[player]]<nowiki>]]</nowiki> [[call]] [[BIS_fnc_dynamicGroups]];//Exec on client</code>


|[[Dynamic Groups]]
|seealso= [[Dynamic Groups]]
}}
}}

Revision as of 00:26, 17 February 2021

Hover & click on the images for description

Description

Description:
Description needed
Execution:
call
Groups:
Systems

Syntax

Syntax:
Syntax needed
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:
Return value needed

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