Multi Theft Auto: Wiki - User contributions [en]

SetPlayerDiscordJoinParams

2019-09-10T07:36:36Z

AliAssassiN:

{{Server function}}
__NOTOC__
{{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.}}

Use empty string for '''key''' parameter to disable join/invite feature.

==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 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==
<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}}

OnPlayerDiscordJoin

2019-07-24T20:41:29Z

AliAssassiN: Created page with "__NOTOC__ {{Server event}} {{New feature/item|3.0160|1.6|7485|This event is triggered when a player accepts game invites from a user in discord or click on "Join" button from..."

__NOTOC__
{{Server event}}

{{New feature/item|3.0160|1.6|7485|This event is triggered when a player accepts game invites from a user in discord or click on "Join" button from that player.}}

==Parameters==
<syntaxhighlight lang="lua">
bool justConnected, string key
</syntaxhighlight>

*'''justConnected''': If true, player connected to the server using game invite, otherwise he's already in the game and not joined the server using discord invite.
*'''key''': The key passed by setPlayerDiscordJoinParams to the player who invited this user.

==Source==
The [[event system#Event source|source]] of this event is the player who is invited to the game/clicked the "Join" button.

==Example==
This example will announce the server that who invited that user from discord.
<syntaxhighlight lang="lua">
function discordJoin(justConnected, key)
local myName = getPlayerName(source)
if justConnected == true then
outputChatBox ( myName .. " been referred here by " .. key )
else
outputChatBox ( myName .. " wanna play with " .. key )
end

local refer = getPlayerFromName(key)
setElementData(refer, "myUsers", getElementData(refer, "myUsers") + 1)
setPlayerDiscordJoinParams(refer, key, key, getElementData(refer, "myUsers"), 5)
end
addEventHandler("onPlayerDiscordJoin", getRootElement(), discordJoin)

function storeDiscordParams()
local myName = getPlayerName(source)
setPlayerDiscordJoinParams(source, myName, myName, 1, 5)
setElementData(source, "myUsers", 1)
end

addEventHandler("onPlayerJoin", getRootElement(), storeDiscordParams)
</syntaxhighlight>

{{See also/Server event|Player events}}

SetPlayerDiscordJoinParams

2019-07-24T19:48:45Z

AliAssassiN:

{{Server function}}
__NOTOC__
{{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.}}

Use empty string for '''key''' parameter to disable join/invite feature.

==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 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==
<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}}

SetPlayerDiscordJoinParams

2019-07-22T20:54:36Z

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

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