VoiceChat#

VoiceChat lets scripts create customized voice chat rooms for players to use in multiplayer.

Warning

VoiceChat is one of the least-documented singletons in the SSE. Only createRoom has any official documentation, and the engine’s public API is known to be inconsistent with the SSE’s usual naming conventions (see Notes below). Additional functions almost certainly exist but are undocumented; treat anything beyond createRoom and the two enumerators below as unverified.

Functions#

VoiceChat.createRoom(name, side, roomType)#

Creates a customized voice chat room that players can join in multiplayer.

Parameters:

  • name (string) – Room name.

  • side (number) – Coalition the room is available to (see VoiceChat.Side).

  • roomType (number) – Room type (see VoiceChat.RoomType).

Enumerators#

VoiceChat.Side identifies which coalition can access a voice room:

Value

Meaning

VoiceChat.Side.NEUTRAL

Neutral (0)

VoiceChat.Side.RED

Red coalition (1)

VoiceChat.Side.BLUE

Blue coalition (2)

VoiceChat.Side.ALL

All coalitions (3)

VoiceChat.RoomType identifies the type of room created:

Value

Meaning

VoiceChat.RoomType.PERSISTENT

Persists independently of any unit (0)

VoiceChat.RoomType.MULTICREW

Tied to a multicrew aircraft (1)

VoiceChat.RoomType.MANAGEABLE

Can be managed/administered (2)

Footnotes#

  • At initial release, the engine’s actual implementation used VoiceChat.CreateRoom (capitalized), inconsistent with the rest of the SSE’s lowercase-first naming convention. This documentation uses the corrected, intended casing (VoiceChat.createRoom); verify against your DCS version if calls silently fail.

  • VoiceChat was added in DCS 2.5.6.