Events

These client-side events can be used to trigger custom functionality in your own scripts, but are not required for basic usage of SaltyChat.

Client

SaltyChat_PluginStateChanged

Parameter	Type	Description
pluginState	int	Current state of the plugin (e.g. client is in a swiss channel), see GameInstanceState for possible values

SaltyChat_TalkStateChanged

Parameter	Type	Description
isTalking	bool	true when player starts talking, false when the player stops talking

SaltyChat_VoiceRangeChanged

Parameter	Type	Description
voiceRange	float	current voice range
index	int	index of the current voice range (starts at 0)
availableVoiceRanges	int	count of available voice ranges

SaltyChat_MicStateChanged

Parameter	Type	Description
isMicrophoneMuted	bool	true when player mutes mic, false when the player unmutes mic

SaltyChat_MicEnabledChanged

Parameter	Type	Description
isMicrophoneEnabled	bool	false when player disabled mic, true when the player enabled mic

SaltyChat_SoundStateChanged

Parameter	Type	Description
isSoundMuted	bool	true when player mutes sound, false when the player unmutes sound

SaltyChat_SoundEnabledChanged

Parameter	Type	Description
isSoundEnabled	bool	false when player disabled sound, true when the player enabled sound

SaltyChat_RadioChannelChanged

Parameter	Type	Description
radioChannel	string	Name of the radio channel, null if channel was left
isPrimaryChannel	bool	true when chanel is primary, false when secondary

SaltyChat_RadioTrafficStateChanged

Parameter	Type	Description
primaryReceive	bool	true when radio traffic is received on primary radio channel
primaryTransmit	bool	true when radio traffic is transmitted on primary radio channel
secondaryReceive	bool	true when radio traffic is received on secondary radio channel
secondaryTransmit	bool	true when radio traffic is transmitted on secondary radio channel