Module public_definitions

Source
Expand description

This file contains the definitions of public_definitions.h and public_rare_definitions.h

Structs§

BBCodeTags
ClientMiniExport
FileTransferCallbackExport
MytsDataUnsetFlags
Speaker
Speaker locations used by some sound callbacks
TransformFilePathExport
Structure used to describe a file transfer in the \ref ServerLibFunctions.onTransformFilePath callback. This describes the original values, and also contains hints for length limitations of the result parameter of the callback. Important: Which values of the struct can be modified is defined by the action value of the original parameter.
TransformFilePathExportReturns
Structure to rewrite the file transfer file name and path in the \ref ServerLibFunctions.onTransformFilePath callback. The lengths are limited as described in the original parameter. Important: Which values of the struct can be modified is defined by the action value of the original parameter.
Ts3Vector
Describes a client position in 3 dimensional space, used for 3D Sound.
VariablesExport
VariablesExportItem
Some structs to handle variables in callbacks

Enums§

ACLType
Access Control List
AwayStatus
ChannelProperties
ClientCommand
This enum is used to disable client commands on the server
ClientProperties
ClientType
CodecEncryptionMode
CodecType
CommandLinePropertiesRare
ConnectStatus
ConnectionProperties
FileListType
File transfer type
FileTransferAction
File transfer actions
FileTransferState
File transfer status
GroupShowNameTreeMode
GroupWhisperTargetMode
GroupWhisperType
HardwareInputStatus
HardwareOutputStatus
HostbannerMode
HostmessageMode
InputDeactivationStatus
LicenseIssue
LocalTestMode
LogLevel
LogTypes
MonoSoundDestination
MuteInputStatus
MuteOutputStatus
PluginTargetMode
ProtocolEncryptionCipher
ReasonIdentifier
SecuritySaltOptions
ServerBinding
ServerInstancePropertiesRare
TalkStatus
TextMessageTargetMode
VirtualServerProperties
Visibility

Constants§

BANDWIDTH_LIMIT_UNLIMITED
MAX_SIZE_AWAY_MESSAGE
MAX_SIZE_CHANNEL_DESCRIPTION
channel description length limit, measured in bytes (utf8 encoded)
MAX_SIZE_CHANNEL_NAME
channel name maximum length in characters
MAX_SIZE_CHANNEL_TOPIC
// channel topic lengt limith, measured in bytes (utf8 encoded)
MAX_SIZE_CLIENT_DESCRIPTION
MAX_SIZE_CLIENT_NICKNAME
client display name length limit in characters
MAX_SIZE_CLIENT_NICKNAME_NONSDK
MAX_SIZE_COMPLAIN_MESSAGE
MAX_SIZE_GROUP_NAME
MAX_SIZE_HOSTBUTTON_TOOLTIP
MAX_SIZE_HOST_MESSAGE
MAX_SIZE_OFFLINE_MESSAGE
MAX_SIZE_OFFLINE_MESSAGE_SUBJECT
MAX_SIZE_POKE_MESSAGE
MAX_SIZE_REASON_MESSAGE
length limit in characters for kick, move, etc reasons
MAX_SIZE_TALK_REQUEST_MESSAGE
MAX_SIZE_TEXTMESSAGE
text message length limit, measured in bytes (utf8 encoded)
MAX_SIZE_USER_TAG
MAX_SIZE_VIRTUALSERVER_HOSTBANNER_GFX_URL
MAX_SIZE_VIRTUALSERVER_NAME
virtual server name maximum length in characters
MAX_SIZE_VIRTUALSERVER_WELCOMEMESSAGE
server welcome message length limit measured in bytes (utf8 encoded)
MAX_VARIABLES_EXPORT_COUNT
MIN_SECONDS_CLIENTID_REUSE
Minimum amount of seconds before a clientID that was in use can be assigned to a new client
MIN_SIZE_CLIENT_NICKNAME
client display name minimum length in characters
MIN_SIZE_CLIENT_NICKNAME_NONSDK
SIZE_MYTSID