WikiSysop: Updating translation from gettext import

2020-07-03T06:09:35Z

Updating translation from gettext import

New page

<languages/>
{{TOC right}}
For an overview on how all of these functions tie in together, see our [[Special:MyLanguage/Manual:Scripting#Discord_Rich_Presence|Discord scripting overview]].


==getDiscordDetail==

;getDiscordDetail()
: Returns the text used for the Discord Rich Presence detail field. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference on where the detail is shown.

See also:
[[#setdiscorddetail|setDiscordDetail]]

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
print("Discord detail is: ".. getDiscordDetail())
</syntaxhighlight>


==getDiscordLargeIcon==

;getDiscordLargeIcon()
: Returns the large icon name used for the Discord Rich Presence. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference on where the large icon is shown.

See also:
[[#setdiscordlargeicon|setDiscordLargeIcon]]

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
print("Discord large icon is: ".. getDiscordLargeIcon())
</syntaxhighlight>


==getDiscordLargeIconText==

;getDiscordLargeIconText()
: Returns the text used as a tooltip for the large icon in the Discord Rich Presence. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference on where the large icon is shown.

See also:
[[#setdiscordlargeicontext|setDiscordLargeIconText]]

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
print("Discord large icon tooltip is: ".. setDiscordLargeIconText())
</syntaxhighlight>


==getDiscordParty==

;getDiscordParty()
: Returns the current and max party values used in the Discord Rich Presence. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference on where the the party info is shown.

See also:
[[#setdiscordparty|setDiscordParty]]

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
local currentsize, maxsize = getDiscordParty()
print(string.format("Discord party: %d out of %d", currentsize, maxsize))
</syntaxhighlight>


==getDiscordSmallIcon==

;getDiscordSmallIcon()
: Returns the small icon name used for the Discord Rich Presence. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference on where the small icon is shown.

See also:
[[#setdiscordsmallicon|setDiscordSmallIcon]]

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
print("Discord small icon is: ".. getDiscordSmallIcon())
</syntaxhighlight>

==getDiscordSmallIconText==

;getDiscordSmallIconText()
: Returns the text used as a tooltip for the small icon in the Discord Rich Presence. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference on where the small icon is shown.

See also:
[[#setdiscordsmallicontext|setDiscordSmallIconText]]

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
print("Discord small icon tooltip is: ".. setDiscordSmallIconText())
</syntaxhighlight>


==getDiscordState==

;getDiscordState()
: Returns the text used for the Discord Rich Presence state field. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference on where the state is shown.

See also:
[[#setdiscordstate|setDiscordState]]

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
print("Discord state is: ".. getDiscordState())
</syntaxhighlight>


==setDiscordApplicationID==

;setDiscordApplicationID(id)
: Set a custom Discord ID so Discord Rich Presence will show "Playing <your game>" instead of "Playing Mudlet". This function is intended for game authors. Note that you can also set it [[Standards:Discord GMCP|automatically over GMCP]], no pre-installation of scripts required. The Discord privacy option "Enable Lua API" must be enabled for this to work. Returns true if the Discord application ID is in the correct format.

If you're a game author, you can register your game [https://discordapp.com/developers/applications/ over at Discord] to obtain the "client ID" to be used for this function. Once you do so, make sure to upload the games icon as an art asset under the name of <code>server-icon</code>.

Mudlet calls the client ID an application ID to avoid confusion with the Mudlet internal Discord client ID.

;Parameters
* ''id:'' (required) id as a string.

[[File:Mudlet Discord ApplicationID.png|thumb|right]]

See also:
[[#setdiscordgame|setDiscordGame]], [[#usingmudletsdiscordid|usingMudletsDiscordID]]

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
-- set the ID to Mudlets own as an example
setDiscordApplicationID("450571881909583884")
</syntaxhighlight>

{{note}} So you do not have to remember that long number you can also reset to the default Mudlet ID by calling this function without an argument:
<syntaxhighlight lang="lua">
setDiscordApplicationID()
</syntaxhighlight>


==setDiscordDetail==

;setDiscordDetail()
: Sets the text to be shown in the detail field of Discord Rich Presence. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference on where the detail is shown. Note that this will overwrite the same information set by [[#setdiscordgame|setDiscordGame()]].

See also:
[[#getdiscorddetail|getDiscordDetail]], [[#setdiscordgame|setDiscordGame]]

{{note}} To ensure privacy, the detail will only be shown if the Lua API is enabled and the detail is not hidden.

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
-- set detail to your character name in-game, as an example
setDiscordDetail("Vadi")
</syntaxhighlight>


==setDiscordElapsedStartTime==

;setDiscordElapsedStartTime(time)
: Sets the time to be shown for "## elapsed" field in Discord Rich Presence. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference on where the elapsed time is shown.

;Parameters
* ''time:'' (required) time as a [https://en.wikipedia.org/wiki/Unix_time Unix time]. To get the current Unix time in Lua, use <code>os.time(os.date("*t"))</code>.

See also:
[[#setdiscordremainingendtime|setDiscordRemainingEndTime]]

{{note}} To ensure privacy, the time will only be shown if the Lua API is enabled and the time is not hidden.

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
-- set the timer to start counting up from now:
setDiscordElapsedStartTime(os.time(os.date("*t")))
</syntaxhighlight>


==setDiscordGame==

;setDiscordGame()
: Sets the given game to be shown in the "detail" field and the game's icon as the large icon in Discord Rich Presence. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference on where the detail and large icon is shown. This is an alternative way of showing which game you're playing - a better way, if you're the game author, is to use [[Standards:Discord GMCP|GMCP]] (no pre-installation of scripts required) or [[#setdiscordapplicationid|setDiscordApplicationID()]].

Currently supported games are: Achaea, Aetolia, Imperian, Luminari, Lusternia, MidMUD, Starmourn, WoTMUD. To add a new game to the list, [https://www.mudlet.org/contact/ get in touch].

See also:
[[#setdiscordapplicationid|setDiscordApplicationID]]

{{note}} To ensure privacy, the game and icon will only be shown if the Lua API is enabled, and detail and large icon are set to show.

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
setDiscordGame("WoTMUD")
</syntaxhighlight>


==setDiscordLargeIcon==

;setDiscordLargeIcon()
: Sets the large icon to be shown in Discord Rich Presence. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference the icon is shown.

Icons supported by default in Mudlet: armor, axe, backpack, bow, coin, dagger, envelope, gem-blue, gem-green, gem-red, hammer, heart, helmet, map, shield, tome, tools, wand, wood-sword ([https://opengameart.org/content/fantasy-icon-pack-by-ravenmore-0 icons credit]). To add a new icon to the list, [https://www.mudlet.org/contact/ get in touch] (the Discord limit is 150 icons).

If you're a game author, you can register your own game with Discord and upload your own icons instead of using the ones registered by Mudlet, see [[#setdiscordapplicationid|setDiscordApplicationID()]].

See also:
[[#getdiscordlargeicon|getDiscordLargeIcon]], [[#setdiscordlargeicontext|setDiscordLargeIconText]], [[#setdiscordapplicationid|setDiscordApplicationID]]

{{note}} To ensure privacy, the icon will only be shown if the Lua API is enabled and the large icon is not hidden.

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
setDiscordLargeIcon("coin")
setDiscordLargeIconText("Fishing")
setDiscordState("Fishing")
</syntaxhighlight>


==setDiscordLargeIconText==

;setDiscordLargeIconText()
: Sets the tooltip for the large icon in the Discord Rich Presence. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference the large icon is shown.

See also:
[[#setdiscordlargeicon|setDiscordLargeIcon]]

{{note}} To ensure privacy, the tooltip will only be shown if the Lua API is enabled, and large icon with the large icon tooltip is set to show.

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
setDiscordLargeIcon("axe")
setDiscordLargeIconText("Killing heterics")
</syntaxhighlight>


==setDiscordParty==

;setDiscordParty(current, max)
: Sets the party information the Discord Rich Presence. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference the party is shown.

;Parameters
* ''current:'' (required) current party amount.
* ''max:'' (optional) max party amount - if not provided, then the max is set to the current amount.

See also:
[[#getdiscordparty|getDiscordParty]]

{{note}} To ensure privacy, the party will only be shown if the Lua API is enabled and the party information is not hidden.

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
-- show that 5 out of 10 people are in currently in the party
setDiscordParty(5, 10)
</syntaxhighlight>


==setDiscordRemainingEndTime==

;setDiscordRemainingEndTime(time)
: Sets the time to be shown for "## remaining" field in Discord Rich Presence. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference on where the remaining time is shown.

;Parameters
* ''time:'' (required) time as a [https://en.wikipedia.org/wiki/Unix_time Unix time]. To get the current Unix time in Lua, use <code>os.time(os.date("*t"))</code>.

See also:
[[#setdiscordelapsedstarttime|setDiscordElapsedStartTime]]

{{note}} To ensure privacy, the time will only be shown if the Lua API is enabled and the time is not hidden.

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
-- set the timer to start counting down from an hour from now
setDiscordRemainingEndTime(os.time(os.date("*t"))+(60 * 60))
</syntaxhighlight>


==setDiscordSmallIcon==

;setDiscordSmallIcon()
: Sets the small icon to be shown in Discord Rich Presence. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference the icon is shown.

Icons supported by default in Mudlet: armor, axe, backpack, bow, coin, dagger, envelope, gem-blue, gem-green, gem-red, hammer, heart, helmet, map, shield, tome, tools, wand, wood-sword ([https://opengameart.org/content/fantasy-icon-pack-by-ravenmore-0 icons credit]). To add a new icon to the list, [https://www.mudlet.org/contact/ get in touch] (the Discord limit is 150 icons).

If you're a game author, you can register your own game with Discord and upload your own icons instead of using the ones registered by Mudlet, see [[#setdiscordapplicationid|setDiscordApplicationID()]].

See also:
[[#getdiscordsmallicon|getDiscordSmallIcon]], [[#setdiscordsmallicontext|setDiscordSmallIconText]], [[#setdiscordapplicationid|setDiscordApplicationID]]

{{note}} To ensure privacy, the icon will only be shown if the Lua API is enabled and the small icon is not hidden.

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
setDiscordSmallIcon("envelope")
setDiscordSmallIconText("Writing letters")
setDiscordState("Writing letters")
</syntaxhighlight>


==setDiscordSmallIconText==

;setDiscordSmallIconText()
: Sets the tooltip for the small icon in the Discord Rich Presence. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference the small icon is shown.

See also:
[[#setdiscordsmallicon|setDiscordSmallIcon]]

{{note}} To ensure privacy, the tooltip will only be shown if the Lua API is enabled, and small icon with the small icon tooltip is set to show.

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
setDiscordSmallIcon("map")
setDiscordSmallIconText("Exploring")
</syntaxhighlight>


==setDiscordState==

;setDiscordState(state)
: Sets the text to be shown in the state field of Discord Rich Presence. See [https://discordapp.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields Discord docs] for a handy image reference on where the state is shown.

See also:
[[#getdiscordstate|getDiscordState]], [[#setdiscorddetail|setDiscordDetail]]

{{note}} To ensure privacy, the state will only be shown if the Lua API is enabled and the state is not hidden.

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
-- set state to your current area
local currentarea = getRoomArea(getPlayerRoom())
local areaname = getAreaTableSwap()[currentarea]
setDiscordDetail(areaname)
</syntaxhighlight>


==usingMudletsDiscordID==

;usingMudletsDiscordID()
: Returns true if the currently playing game is set to "Mudlet". You can change this with [[#setdiscordapplicationid|setDiscordApplicationID()]].

See also:
[[#setdiscordapplicationid|setDiscordApplicationID]]

{{note}} Available since Mudlet 3.14.

;Example
<syntaxhighlight lang="lua">
if usingMudletsDiscordID() then
print('It is showing "Playing Mudlet" right now!')
end
</syntaxhighlight>

Manual:Discord Functions/pl - Revision history

WikiSysop: Updating translation from gettext import