(Created page with "{{Template:dcs_funcs |fName= createRoom |vNum= 2.5.6 |par1= VoiceChat |par2= |par3= |par4= |desc= Creates a VoiceChat room for players to...") |
|||
| Line 69: | Line 69: | ||
}} | }} | ||
[[Category:Singleton Functions|creatRoom]] | [[Category:Singleton Functions|creatRoom]] | ||
| + | [[Category:Game Patch 2.5.6|createRoom]] | ||
| Envrioment: | Mission Scripting | ||
| Function: | createRoom | Added with: 2.5.6 | |
| Member Of: | VoiceChat | ||
| Syntax: | nothing VoiceChat.createRoom(string roomName , number side , number roomType) | ||
| Description: | Creates a VoiceChat room for players to join and interact with each other in a multiplayer mission.
Side for which the voice room is available to players. VoiceChat.Side = {
NEUTRAL = 0
RED = 1
BLUE = 2
ALL = 3
}
The type of room that is created. VoiceChat.RoomType= {
PERSISTENT = 0
MULTICREW = 1
MANAGEABLE = 2
}
| ||
| Return Value: | nothing | ||
| Return Example: | |||
| Examples: | VoiceChat.CreateRoom("SRSIsBetter", 2, 0) | ||
| Related Functions: | Voice Functions: createRoom | ||
| Notes: | On initial release this function is called via VoiceChat.CreateRoom.
Room type multicrew and manageable are both used by the game but are not available to the scripting function to add rooms. Your only choice is 0 or to leave it blank. | ||
