GetPCChatVolume()

Retrieves the volume of the last player chat message that was sent.

int GetPCChatVolume();

Description

Retrieves the volume of the last player chat (text) message that was sent.



Remarks

Returns a TALKVOLUME_* constant based on the volume setting that the player used to send the chat message. Returns -1 on error.

Should only be called from a module's OnPlayerChat event script.

Note: Private tells do not trigger a OnPlayerChat event.


Version

1.69

Example

See OnPlayerChat.

See Also

functions:  GetPCChatMessage | GetPCChatSpeaker | SetPCChatMessage | SetPCChatVolume
constants:  TALKVOLUME_*
events:  OnPlayerChat Event


author: Mistress, contributor: Axe Murderer