SetPlayerDiscordJoinParams - Revision history

XNikoXD at 09:24, 26 October 2025

2025-10-26T09:24:17Z

← Older revision		Revision as of 09:24, 26 October 2025
Line 1:		Line 1:
	{{Server function}} __NOTOC__		{{Server function}} __NOTOC__
	{{Important Note\|~~The name of this~~ function ~~will change~~, ~~so you should first check that the function exists before using it~~.~~<syntaxhighlight lang="lua">~~		{{Important Note\|This function was removed, read https://github.com/multitheftauto/mtasa-blue/pull/2499 for more information.}}
	~~if setPlayerDiscordJoinParams then~~
	~~setPlayerDiscordJoinParams(...)~~
	~~end<~~/~~syntaxhighlight>}}~~
	~~{{New feature~~/~~item\|3.0160\|1.6\|20463\|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.		Use empty string for '''key''' parameter to disable join/invite feature.

Qaisjp: likely to change

2020-03-30T10:22:00Z

likely to change

← Older revision		Revision as of 10:22, 30 March 2020
Line 1:		Line 1:
	{{Server function}} __NOTOC__		{{Server function}} __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">		{{Important Note\|The name of this function will change, so you should first check that the function exists before using it.<syntaxhighlight lang="lua">
	if setPlayerDiscordJoinParams then		if setPlayerDiscordJoinParams then
	setPlayerDiscordJoinParams(...)		setPlayerDiscordJoinParams(...)

Qaisjp: fix rev

2020-03-27T03:16:38Z

fix rev

← Older revision		Revision as of 03:16, 27 March 2020
Line 4:		Line 4:
	setPlayerDiscordJoinParams(...)		setPlayerDiscordJoinParams(...)
	end</syntaxhighlight>}}		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\|20463\|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.}}

Qaisjp: add extra missing partyMaxSize restriction

2020-03-27T02:10:55Z

add extra missing partyMaxSize restriction

← Older revision		Revision as of 02:10, 27 March 2020
Line 20:		Line 20:
	*'''partyId:''' Changing the partyId is useful to make invites expire. (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)		*'''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. (Can't be greater than server max players)

	===Returns===		===Returns===

Qaisjp: maybe fix space again

2020-03-27T02:03:41Z

maybe fix space again

← Older revision		Revision as of 02:03, 27 March 2020
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">		{{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		if setPlayerDiscordJoinParams then

Qaisjp: fix space?

2020-03-27T02:03:06Z

fix space?

← Older revision		Revision as of 02:03, 27 March 2020
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.		{{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">

	<syntaxhighlight lang="lua">
	if setPlayerDiscordJoinParams then		if setPlayerDiscordJoinParams then
	setPlayerDiscordJoinParams(...)		setPlayerDiscordJoinParams(...)
	end		end</syntaxhighlight>}}
	</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.}}

Qaisjp: add important note

2020-03-27T02:02:49Z

add important note

← Older revision		Revision as of 02:02, 27 March 2020
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.}}

AliAssassiN at 07:36, 10 September 2019

2019-09-10T07:36:36Z

← Older revision		Revision as of 07:36, 10 September 2019
Line 14:		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 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, must not contain space character)
	*'''partyId:''' Changing the partyId is useful to make invites expire. (Limited to 64 characters)		*'''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)		*'''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.

AliAssassiN at 19:48, 24 July 2019

2019-07-24T19:48:45Z

← Older revision		Revision as of 19:48, 24 July 2019
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.

AliAssassiN: 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...."

2019-07-22T20:54:36Z

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...."

New page

{{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.

==Syntax==

<syntaxhighlight lang="lua">
bool setPlayerDiscordJoinParams ( element thePlayer, string key, string partyId, int partyCurrentSize, int partyMaxSize )
</syntaxhighlight>
{{OOP||[[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 >=5 and <=64 characters)
*'''partyId:''' Changing the partyId is useful to make invites expire. (Limited to >=5 and <=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==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">function makeSomeParty ( playerSource, cmdName )
setPlayerDiscordJoinParams(playerSource, "abcdefghijklmnopqrstuvwxyz", "abc123456", 1, 5)
end

addCommandHandler ( "makeParty", makeSomeParty )
</syntaxhighlight>
</section>

==See Also==
{{Player_functions}}