SetPlayerDiscordJoinParams
From Multi Theft Auto: Wiki
FROM VERSION 1.6 r7485 ONWARDS
This function allows you to set a user's Discord join/invite parameters.
It's necessary to use this function to enable that option on Discord.
Use empty string for key parameter to disable join/invite feature.
Syntax
bool setPlayerDiscordJoinParams ( element thePlayer, string key, string partyId, int partyCurrentSize, int partyMaxSize )
OOP Syntax Help! I don't understand this!
- Method: player:setDiscordJoinParams(...)
Required Arguments
- thePlayer: The player whose discord join parameters will be set on.
- key: The key which will be called upon invited users (or users who joined the game by clicking "Join") onPlayerJoin event. (Limited to 64 characters, must not contain space character)
- partyId: Changing the partyId is useful to make invites expire. (Limited to 64 characters, must not contain space character)
- partyCurrentSize: The current number of used capacity for other users to join. (Can't be more than partyMaxSize)
- partyMaxSize: The total capacity for users inside the party.
Returns
Returns true if the value was set successfully, false otherwise.
Example
Click to collapse [-]
Serverfunction makeSomeParty ( playerSource, cmdName ) setPlayerDiscordJoinParams(playerSource, "abcdefghijklmnopqrstuvwxyz", "abc123456", 1, 5) end addCommandHandler ( "makeParty", makeSomeParty )
See Also
- forcePlayerMap
- getAlivePlayers
- getDeadPlayers
- getPlayerACInfo
- getPlayerAnnounceValue
- getPlayerBlurLevel
- getPlayerCount
- getPlayerFromName
- getPlayerIdleTime
- getPlayerIP
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerNametagText
- getPlayerPing
FROM VERSION 1.5.7 r19626 ONWARDS
- getPlayerSerial
- getPlayerTeam
- getPlayerVersion
- getPlayerWantedLevel
- getRandomPlayer
- givePlayerMoney
- isPlayerMapForced
- isPlayerMuted
- isPlayerNametagShowing
- isVoiceEnabled
- redirectPlayer
- resendPlayerACInfo
- resendPlayerModInfo
- setPlayerAnnounceValue
- setPlayerBlurLevel
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerMuted
- setPlayerName
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
FROM VERSION 1.5.7 r19626 ONWARDS
- setPlayerTeam
- setPlayerVoiceBroadcastTo
- setPlayerVoiceIgnoreFrom
- setPlayerWantedLevel
- spawnPlayer
- takePlayerMoney
- takePlayerScreenShot