SetPlayerDiscordJoinParams: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (add important note)
Line 1: Line 1:
{{Server function}}
{{Server function}}
__NOTOC__
__NOTOC__
{{Important Note|This is function is experimental and you should first check that the function exists before using it. The function can be removed at any time.
<syntaxhighlight lang="lua">
if setPlayerDiscordJoinParams then
    setPlayerDiscordJoinParams(...)
end
</syntaxhighlight>
}}
{{New feature/item|3.0160|1.6|7485|This function allows you to set a user's Discord join/invite parameters.
{{New feature/item|3.0160|1.6|7485|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.}}
It's necessary to use this function to enable that option on Discord.}}

Revision as of 02:02, 27 March 2020


[[{{{image}}}|link=|]] Important Note: This is function is experimental and you should first check that the function exists before using it. The function can be removed at any time. 
if setPlayerDiscordJoinParams then
    setPlayerDiscordJoinParams(...)
end

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 [-]
Server
function makeSomeParty ( playerSource, cmdName )
    setPlayerDiscordJoinParams(playerSource, "abcdefghijklmnopqrstuvwxyz", "abc123456", 1, 5)
end

addCommandHandler ( "makeParty", makeSomeParty )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetPlayerDiscordJoinParams?oldid=65561"