Announcement Functions

Author: FileEX

functions/Announcement/examples/getGameType-1.lua

@@ -0,0 +1,6 @@
+local function playerJoinHandler()
+   if (getGameType() == "Race") then
+      outputChatBox("Ready... Get set... GO!!", source)
+   end
+end
+addEventHandler("onPlayerJoin", root, playerJoinHandler)

functions/Announcement/examples/getMapName-1.lua

@@ -0,0 +1,9 @@
+local function checkMap ( thePlayer )
+    local mapName = getMapName() -- get the maps name
+	if (mapName and mapName ~= "None") then -- if map name was set and it isn't "None" (default map name)
+        outputChatBox("You're playing map called \"" .. mapName .. "\"", thePlayer) -- print out the map name
+    else -- there was no name so tell that to player
+        outputChatBox("You're playing an unnamed map.", thePlayer) -- print out the message
+    end
+end
+addCommandHandler("checkmap", checkMap)

functions/Announcement/examples/getRuleValue-1.lua

@@ -0,0 +1,3 @@
+if (getRuleValue ( "myScriptRunning" )) then
+    -- the value is set
+end

functions/Announcement/examples/removeRuleValue-1.lua

@@ -0,0 +1 @@
+removeRuleValue("myScriptRunning")

functions/Announcement/examples/setGameType-1.lua

@@ -0,0 +1,6 @@
+local function setNewGameType(source, commandName, newGameType)
+    local oldGameType = getGameType() -- check old Game Type
+    setGameType(newGameType) -- set new Game Type
+    outputChatBox("Game Type " .. oldGameType .. " changed to " .. newGameType .. ".", getRootElement(), 255, 128, 0)
+end
+addCommandHandler("setgametype", setNewGameType)

functions/Announcement/examples/setMapName-1.lua

@@ -0,0 +1 @@
+setMapName("My amazing map!")

functions/Announcement/examples/setRuleValue-1.lua

@@ -0,0 +1 @@
+setRuleValue("myScriptRunning", "yes")

functions/Announcement/getGameType.yaml

@@ -1,5 +1,12 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/getGameType
 server:
   name: getGameType
-  description: TODO
-  incomplete: true
+  pair: setGameType
+  description: This function retrieves the current gametype as set by [[setGameType]]. The game type is displayed in the server browser next to the server's name.
+  returns:
+    values:
+      - type: string|nil
+        name: game type (gamemode)
+    description: Returns the gametype as a string. If no gametype is set it returns [[nil]].
+  examples:
+    - path: examples/getGameType-1.lua
+      description: This example sends a message to player when he joins, if the current game type is Race.

functions/Announcement/getMapName.yaml

@@ -1,5 +1,12 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/getMapName
 server:
   name: getMapName
-  description: TODO
-  incomplete: true
+  pair: setMapName
+  description: This function retrieves the current mapname as set by [[setMapName]].
+  returns:
+    values:
+      - type: string|nil
+        name: map name
+    description: Returns the mapname as a [[string]]. If no mapname is set it returns [[nil]].
+  examples:
+    - path: examples/getMapName-1.lua
+      description: This example adds a <code>checkmap</code> command with which you can check what map you are currently playing.

functions/Announcement/getRuleValue.yaml

@@ -1,5 +1,13 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/getRuleValue
 server:
   name: getRuleValue
-  description: TODO
-  incomplete: true
+  pair: setRuleValue
+  description: This function gets a rule value. A rule value is a string that can be viewed by server browsers and used for filtering the server list.
+  returns:
+    values:
+      - type: string|nil
+        name: rule value
+    description: This example shows how you can check if a rule is set.
+
+  examples:
+    - path: examples/getRuleValue-1.lua
+      description: This example shows how you can check if a rule is set.