Discord functions

FileEX · FileEX · commit 6d41983d57d1 · 2025-12-07T03:16:19.000+01:00
diff --git a/elements/Discord/discordrpc.yaml b/elements/Discord/discordrpc.yaml
@@ -0,0 +1,2 @@
+name: discordrpc
+description: The **discordrpc** class represents a static class providing functions for Discord Rich Presence.
diff --git a/functions/Discord/examples/getDiscordRichPresenceUserID-1.lua b/functions/Discord/examples/getDiscordRichPresenceUserID-1.lua
@@ -1,12 +1,10 @@
-addCommandHandler("getmyuserid",
-    function ()
-        if isDiscordRichPresenceConnected() then
-            local id = getDiscordRichPresenceUserID() 
-            if id == "" then 
-                outputChatBox("You didn't allow consent to share Discord data! Grant permission in the settings!")
-            else 
-                outputChatBox("Your Discord userid: "..id)
-            end 
-        end 
+addCommandHandler("getmyuserid", function()
+    if isDiscordRichPresenceConnected() then
+        local id = getDiscordRichPresenceUserID()
+        if id == "" then
+            outputChatBox("You didn't allow consent to share Discord data! Grant permission in the settings!")
+        else
+            outputChatBox("Your Discord userid: " .. id)
+        end
     end
-)
+end)
diff --git a/functions/Discord/examples/isDiscordRichPresenceConnected-1.lua b/functions/Discord/examples/isDiscordRichPresenceConnected-1.lua
@@ -1,7 +1,5 @@
-addCommandHandler("checkdiscord",
-    function ()
-        if isDiscordRichPresenceConnected() then 
-            outputChatBox("You are using Discord Rich Presence, that's cool!")
-        end 
+addCommandHandler("checkdiscord", function()
+    if isDiscordRichPresenceConnected() then
+        outputChatBox("You are using Discord Rich Presence, that's cool!")
     end
-)
+end)
diff --git a/functions/Discord/examples/isDiscordRichPresenceConnected_OOP-1.lua b/functions/Discord/examples/isDiscordRichPresenceConnected_OOP-1.lua
@@ -0,0 +1,5 @@
+addCommandHandler("checkdiscord", function()
+    if DiscordRPC.isConnected() then
+        outputChatBox("You are using Discord Rich Presence, that's cool!")
+    end
+end)
diff --git a/functions/Discord/examples/setDiscordApplicationID_OOP-1.lua b/functions/Discord/examples/setDiscordApplicationID_OOP-1.lua
@@ -0,0 +1,5 @@
+local app_id = "YOUR_APPLICATION_ID"
+if DiscordRPC.setApplication(app_id) then 
+    DiscordRPC.setAsset("asset_name_from_application")
+    outputChatBox("Yay, we're now using our own application!")
+end
diff --git a/functions/Discord/examples/setDiscordRichPresenceAsset-1.lua b/functions/Discord/examples/setDiscordRichPresenceAsset-1.lua
@@ -1,7 +1,5 @@
-addCommandHandler("setlogo",
-    function ()
-        if isDiscordRichPresenceConnected() then 
-            setDiscordRichPresenceAsset("my_logo", "This is my logo!")
-        end 
+addCommandHandler("setlogo", function()
+    if isDiscordRichPresenceConnected() then
+        setDiscordRichPresenceAsset("my_logo", "This is my logo!")
     end
-)
+end)
diff --git a/functions/Discord/examples/setDiscordRichPresenceAsset_OOP-1.lua b/functions/Discord/examples/setDiscordRichPresenceAsset_OOP-1.lua
@@ -0,0 +1,5 @@
+addCommandHandler("setlogo", function()
+    if DiscordRPC.isConnected() then
+        DiscordRPC.setAsset("my_logo", "This is my logo!")
+    end
+end)
diff --git a/functions/Discord/examples/setDiscordRichPresenceButton_OOP-1.lua b/functions/Discord/examples/setDiscordRichPresenceButton_OOP-1.lua
@@ -0,0 +1,5 @@
+local app_id = "YOUR_APPLICATION_ID"
+if DiscordRPC.setApplication(app_id) then 
+    DiscordRPC.setButton(1, "Connect to server", "mtasa://youraddressip")
+    DiscordRPC.setButton(2, "MTA Homepage", "https://mtasa.com")
+end
diff --git a/functions/Discord/examples/setDiscordRichPresenceDetails_OOP-1.lua b/functions/Discord/examples/setDiscordRichPresenceDetails_OOP-1.lua
@@ -0,0 +1,6 @@
+local app_id = "YOUR_APPLICATION_ID"
+if DiscordRPC.setApplication(app_id) then 
+    local name = localPlayer.name
+    DiscordRPC.setState("In-game")
+    DiscordRPC.setDetails("currently as "..name)
+end
diff --git a/functions/Discord/examples/setDiscordRichPresenceEndTime_OOP-1.lua b/functions/Discord/examples/setDiscordRichPresenceEndTime_OOP-1.lua
@@ -0,0 +1,6 @@
+local app_id = "YOUR_APPLICATION_ID"
+if DiscordRPC.setApplication(app_id) then 
+    DiscordRPC.setState("In-game")
+    DiscordRPC.setStartTime(1)
+    DiscordRPC.setEndTime(60) -- 1 minute Remaining
+end
diff --git a/functions/Discord/examples/setDiscordRichPresencePartySize_OOP-1.lua b/functions/Discord/examples/setDiscordRichPresencePartySize_OOP-1.lua
@@ -0,0 +1,5 @@
+local app_id = "YOUR_APPLICATION_ID"
+if DiscordRPC.setApplication(app_id) then 
+    DiscordRPC.setState("In-game")
+    DiscordRPC.setPartySize(1, 32)
+end
diff --git a/functions/Discord/examples/setDiscordRichPresenceSmallAsset-1.lua b/functions/Discord/examples/setDiscordRichPresenceSmallAsset-1.lua
@@ -1,7 +1,5 @@
-addCommandHandler("setsmalllogo",
-    function ()
-        if isDiscordRichPresenceConnected() then 
-            setDiscordRichPresenceSmallAsset("my_small_logo", "This is my small logo!")
-        end 
+addCommandHandler("setsmalllogo", function()
+    if isDiscordRichPresenceConnected() then
+        setDiscordRichPresenceSmallAsset("my_small_logo", "This is my small logo!")
     end
-)
+end)
diff --git a/functions/Discord/examples/setDiscordRichPresenceSmallAsset_OOP-1.lua b/functions/Discord/examples/setDiscordRichPresenceSmallAsset_OOP-1.lua
@@ -0,0 +1,5 @@
+addCommandHandler("setsmalllogo", function()
+    if DiscordRPC.isConnected() then
+        DiscordRPC.setSmallAsset("my_small_logo", "This is my small logo!")
+    end
+end)
diff --git a/functions/Discord/examples/setDiscordRichPresenceStartTime_OOP-1.lua b/functions/Discord/examples/setDiscordRichPresenceStartTime_OOP-1.lua
@@ -0,0 +1,5 @@
+local app_id = "YOUR_APPLICATION_ID"
+if DiscordRPC.setApplication(app_id) then 
+    DiscordRPC.setState("In-game")
+    DiscordRPC.setStartTime(1)
+end
diff --git a/functions/Discord/examples/setDiscordRichPresenceState_OOP-1.lua b/functions/Discord/examples/setDiscordRichPresenceState_OOP-1.lua
@@ -0,0 +1,4 @@
+local app_id = "YOUR_APPLICATION_ID"
+if DiscordRPC.setApplication(app_id) then 
+    DiscordRPC.setState("waiting in lobby")
+end
diff --git a/functions/Discord/getDiscordRichPresenceUserID.yaml b/functions/Discord/getDiscordRichPresenceUserID.yaml
@@ -1,23 +1,21 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/GetDiscordRichPresenceUserID
-shared:
+client:
   name: getDiscordRichPresenceUserID
   description: The function returns the client Discord UserID.
-  parameters: []
   examples:
   - path: examples/getDiscordRichPresenceUserID-1.lua
     description: This example displays the user's userid in the chat if they have
       granted permission to share data. Otherwise, they will receive an appropriate
       message.
-    side: client
   returns:
     values:
     - type: string
-      name: value
-    description: It will return an empty string ("") if the user has not given consent
+      name: user id
+    description: It will return an empty [[string]] ("") if the user has not given consent
       or has disabled the Rich Presence synchronization option. Otherwise, it will
-      return the userid as a string.
+      return the userid as a [[string]].
   notes:
   - type: important
     content: The function will correctly return the UserID if the user has given consent
       beforehand and is connected to the Rich Presence application.
-  requires_review: true
+  version:
+    added: 1.6.0 r22342
diff --git a/functions/Discord/isDiscordRichPresenceConnected.yaml b/functions/Discord/isDiscordRichPresenceConnected.yaml
@@ -1,21 +1,23 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/IsDiscordRichPresenceConnected
-shared:
+client:
   name: isDiscordRichPresenceConnected
   description: The function checks if the client has Discord Rich Presence enabled.
-  parameters: []
   examples:
   - path: examples/isDiscordRichPresenceConnected-1.lua
     description: This example outputs whether the client has enabled Discord Rich
       Presence.
-    side: client
+  - path: examples/isDiscordRichPresenceConnected_OOP-1.lua
+    description: This example outputs whether the client has enabled Discord Rich
+      Presence.
+    oop: true
   returns:
     values:
     - type: bool
-      name: value
-    description: Returns true if Discord Rich Presence is enabled on the client, false
+      name: result
+    description: Returns **true** if Discord Rich Presence is enabled on the client, **false**
       if disabled.
   oop:
     element: discordrpc
     method: isConnected
-    static: false
-  requires_review: true
+    static: true
+  version:
+    added: 1.6.0 r22270
diff --git a/functions/Discord/resetDiscordRichPresenceData.yaml b/functions/Discord/resetDiscordRichPresenceData.yaml
@@ -1,16 +1,14 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/ResetDiscordRichPresenceData
-shared:
+client:
   name: resetDiscordRichPresenceData
   description: The function resets the Discord Rich Presence configuration to default.
-  parameters: []
   examples:
   - path: examples/resetDiscordRichPresenceData-1.lua
     description: The example shows how to reset Discord Rich Presence after using
       a custom application.
-    side: client
   returns:
     values:
     - type: bool
-      name: value
-    description: Returns true if function succeeds, false otherwise.
-  requires_review: true
+      name: result
+    description: Returns **true** if function succeeds, **false** otherwise.
+  version:
+    added: 1.6.0 r22270
diff --git a/functions/Discord/setDiscordApplicationID.yaml b/functions/Discord/setDiscordApplicationID.yaml
@@ -1,32 +1,35 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/SetDiscordApplicationID
-shared:
+client:
   name: setDiscordApplicationID
   description: 'The function can assign your own application to use in Rich Presence.
 
     You can create an application **[here](https://discord.com/developers/applications)**'
   parameters:
   - name: applicationID
     type: string
-    description: a string representing your Discord application's ID.
+    description: a [[string]] representing your Discord application's ID.
   examples:
   - path: examples/setDiscordApplicationID-1.lua
     description: This example outputs whether the application was successfully setup
       and sets a custom asset image.
-    side: client
+  - path: examples/setDiscordApplicationID_OOP-1.lua
+    description: This example outputs whether the application was successfully setup
+      and sets a custom asset image.
+    oop: true
   returns:
     values:
     - type: bool
-      name: value
-    description: Returns true if function succeeds, false if the client has disabled
+      name: reset
+    description: Returns **true** if function succeeds, **false** if the client has disabled
       rich presence.
   oop:
     element: discordrpc
     method: setApplication
-    static: false
+    static: true
   notes:
-  - type: important
-    content: To reset the application ID, please use resetDiscordRichPresenceData
+  - type: info
+    content: To reset the application ID, please use [[resetDiscordRichPresenceData]].
   - type: important
     content: In order for the function to work correctly, the user must have their
       activity privacy/status enabled in Discord.
-  requires_review: true
+  version:
+    added: 1.6.0 r22270
diff --git a/functions/Discord/setDiscordRichPresenceAsset.yaml b/functions/Discord/setDiscordRichPresenceAsset.yaml
@@ -1,31 +1,33 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/SetDiscordRichPresenceAsset
-shared:
+client:
   name: setDiscordRichPresenceAsset
   description: Using this function you can set the large image asset of the application.
     The maximum size of assets is *1024x1024*, the minimum is *512x512*.
   parameters:
   - name: assetImage
     type: string
-    description: a string containing the key of the image you uploaded to your application's
+    description: A [[string]] containing the key of the image you uploaded to your application's
       asset list.
   - name: text
     type: string
-    description: a string to be displayed when someone hovers over the large image
-      asset in Discord.
+    description: A [[string]] to be displayed when someone hovers over the large image
+      asset in Discord. Max 128 characters.
   examples:
   - path: examples/setDiscordRichPresenceAsset-1.lua
-    description: The example sets the large image asset to my_logo.
-    side: client
+    description: The example sets the large image asset to `my_logo`.
+  - path: examples/setDiscordRichPresenceAsset_OOP-1.lua
+    description: The example sets the large image asset to `my_logo`.
+    oop: true
   returns:
     values:
     - type: bool
-      name: value
-    description: Returns true if function succeeds, false otherwise.
+      name: result
+    description: Returns **true** if function succeeds, **false** otherwise.
   oop:
     element: discordrpc
     method: setAsset
-    static: false
+    static: true
   notes:
   - type: important
-    content: To use this function, you must set up your own application setDiscordApplicationID
-  requires_review: true
+    content: To use this function, you must set up your own application [[setDiscordApplicationID]].
+  version:
+    added: 1.6.0 r22270
diff --git a/functions/Discord/setDiscordRichPresenceButton.yaml b/functions/Discord/setDiscordRichPresenceButton.yaml
@@ -1,35 +1,36 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/SetDiscordRichPresenceButton
-shared:
+client:
   name: setDiscordRichPresenceButton
   description: The function sets a custom button through which we can access the website
     on Discord.
   parameters:
   - name: index
     type: int
-    description: 'a int representing the index of the button (possible values: 1 or
-      2)'
+    description: 'A [[int]] representing the index of the button (possible values: 1 or 2)'
   - name: text
     type: string
-    description: a string containing the title of the button
+    description: A [[string]] containing the title of the button. Max 32 characters.
   - name: url
     type: string
-    description: a string containing the button URL (only works with https:// or mtasa://
-      )
+    description: A [[string]] containing the button URL (only works with **https://** or **mtasa://**)
   examples:
   - path: examples/setDiscordRichPresenceButton-1.lua
     description: This example creates two custom buttons in our Discord Rich Presence
       application.
-    side: client
+  - path: examples/setDiscordRichPresenceButton_OOP-1.lua
+    description: This example creates two custom buttons in our Discord Rich Presence
+      application.
+    oop: true
   returns:
     values:
     - type: bool
-      name: value
-    description: Returns true if function succeeds, false otherwise.
+      name: result
+    description: Returns **true** if function succeeds, **false** otherwise.
   oop:
     element: discordrpc
     method: setButton
-    static: false
+    static: true
   notes:
   - type: important
-    content: To use this function, you must set up your own application setDiscordApplicationID
-  requires_review: true
+    content: To use this function, you must set up your own application [[setDiscordApplicationID]].
+  version:
+    added: 1.6.0 r22270
diff --git a/functions/Discord/setDiscordRichPresenceDetails.yaml b/functions/Discord/setDiscordRichPresenceDetails.yaml
diff --git a/functions/Discord/setDiscordRichPresenceEndTime.yaml b/functions/Discord/setDiscordRichPresenceEndTime.yaml
diff --git a/functions/Discord/setDiscordRichPresencePartySize.yaml b/functions/Discord/setDiscordRichPresencePartySize.yaml
diff --git a/functions/Discord/setDiscordRichPresenceSmallAsset.yaml b/functions/Discord/setDiscordRichPresenceSmallAsset.yaml
diff --git a/functions/Discord/setDiscordRichPresenceStartTime.yaml b/functions/Discord/setDiscordRichPresenceStartTime.yaml
diff --git a/functions/Discord/setDiscordRichPresenceState.yaml b/functions/Discord/setDiscordRichPresenceState.yaml
diff --git a/web/src/utils/functions.ts b/web/src/utils/functions.ts

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+name: discordrpc`
	`2`	`+description: The discordrpc class represents a static class providing functions for Discord Rich Presence.`