SetPlayerDiscordJoinParams: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Server function}} __NOTOC__ 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....")
 
No edit summary
Line 1: Line 1:
{{Server function}}
{{Server function}}
__NOTOC__  
__NOTOC__
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.}}
 
Use empty string for '''key''' parameter to disable join/invite feature.


==Syntax==  
==Syntax==  
Line 12: Line 14:
===Required Arguments===  
===Required Arguments===  
*'''thePlayer:''' The [[player]] whose discord join parameters will be set on.
*'''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 >=5 and <=64 characters)
*'''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)
*'''partyId:''' Changing the partyId is useful to make invites expire. (Limited to >=5 and <=64 characters)
*'''partyId:''' Changing the partyId is useful to make invites expire. (Limited to 64 characters)
*'''partyCurrentSize:''' The current number of used capacity for other users to join. (Can't be more than partyMaxSize)
*'''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.
*'''partyMaxSize:''' The total capacity for users inside the party.

Revision as of 19:48, 24 July 2019

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)
  • partyId: Changing the partyId is useful to make invites expire. (Limited to 64 characters)
  • 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

Shared


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