Automatic scraping of event examples! None is missing an example now.

Author: Fernando-A-Rocha

events/Account/examples/onAccountCreate-1.lua

@@ -0,0 +1,5 @@
+addEventHandler('onAccountCreate', root, function(acc)
+    local accName = getAccountName(acc)
+    local accType = getAccountType(acc) or ''
+    iprint('Registered a new '..accType..' account: '..accName)
+end)

events/Account/examples/onAccountDataChange-1.lua

@@ -0,0 +1,6 @@
+function preventLevelChange(account, key, value)
+    if (key == "level") then
+        cancelEvent()
+    end
+end
+addEventHandler("onAccountDataChange", root, preventLevelChange)

events/Account/examples/onAccountDataChange-2.lua

@@ -0,0 +1,5 @@
+function preventLevelChange(account, key, value)
+    if (wasEventCancelled()) then return end -- If the data change was aborted don't log it.
+    outputServerLog(getAccountName(account) .. " key: " .. key .. " changed to: " .. tostring(value))
+end
+addEventHandler("onAccountDataChange", root, preventLevelChange)

events/Account/examples/onAccountRemove-1.lua

@@ -0,0 +1,5 @@
+addEventHandler('onAccountRemove', root, function(acc)
+    local accName = getAccountName(acc)
+    local accType = getAccountType(acc) or 'Unknown'
+    iprint('An account has been removed! Type: '..accType..', name: '..accName)
+end)

events/Account/onAccountCreate.yaml

@@ -10,4 +10,8 @@ parameters:
 - name: theAccount
   type: account
   description: An account element that was created
+examples:
+- path: examples/onAccountCreate-1.lua
+  description: This example prints a message every time new account is created.
+  side: server
 canceling: This event cannot be canceled.

events/Account/onAccountDataChange.yaml

@@ -16,3 +16,11 @@ parameters:
 - name: theValue
   type: string
   description: the value it is changing to.
+examples:
+- path: examples/onAccountDataChange-1.lua
+  description: This examples prevents the key of "level" being added or changed on
+    every account.
+  side: server
+- path: examples/onAccountDataChange-2.lua
+  description: This examples logs every single account data change to server log.
+  side: server

events/Account/onAccountRemove.yaml

@@ -10,4 +10,8 @@ parameters:
 - name: theAccount
   type: account
   description: An account element that was removed
+examples:
+- path: examples/onAccountRemove-1.lua
+  description: This example prints a message every time new account is created.
+  side: server
 canceling: This event cannot be canceled.

events/Browser/examples/onClientBrowserCreated-1.lua

@@ -0,0 +1,5 @@
+addEventHandler("onClientBrowserCreated", resourceRoot,
+function ()
+    -- when the browser is loaded
+    loadBrowserURL(source, "http://mtasa.com") -- load MTA:SA site
+end)

events/Browser/examples/onClientBrowserCursorChange-1.lua

@@ -0,0 +1 @@
+TODO

events/Browser/examples/onClientBrowserDocumentReady-1.lua

@@ -0,0 +1,5 @@
+addEventHandler ( "onClientBrowserDocumentReady" , root , 
+	function ( url ) 
+		outputChatBox ( "The page '"  .. url ..  "' has been successfully loaded.") 
+	end 
+)

events/Browser/examples/onClientBrowserLoadingFailed-1.lua

@@ -0,0 +1,5 @@
+addEventHandler("onClientBrowserLoadingFailed", root,
+	function(url, errorCode, errorDescription)
+		outputChatBox("This webpage is not available" .. url .. "Unknown" .. errorCode .. "Unknown" .. errorDescription)
+	end
+)

events/Browser/examples/onClientBrowserLoadingStart-1.lua

@@ -0,0 +1,16 @@
+local browser = guiCreateBrowser(0, 0, 800, 600, false, false, false)
+local theBrowser = guiGetBrowser(browser)
+showCursor(true)
+
+
+addEventHandler("onClientBrowserLoadingStart", theBrowser, function(url, isMainFrame)
+  if (isMainFrame) then
+    outputChatBox("Loading "..url.." in the main frame...")
+  else
+    outputChatBox("Loading "..url.." in a iframe...")
+  end
+end)
+
+addEventHandler("onClientBrowserCreated", theBrowser, function()
+  loadBrowserURL(source, "https://www.w3schools.com/html/html_iframe.asp")
+end)

events/Browser/examples/onClientBrowserNavigate-1.lua

@@ -0,0 +1 @@
+-- TODO

events/Browser/examples/onClientBrowserPopup-1.lua

@@ -0,0 +1 @@
+TODO

events/Browser/examples/onClientBrowserResourceBlocked-1.lua

@@ -0,0 +1,22 @@
+local browser = guiCreateBrowser(0, 0, 800, 600, false, false, false)
+local theBrowser = guiGetBrowser(browser)
+showCursor(true)
+
+addEventHandler("onClientBrowserCreated", theBrowser, function()
+  loadBrowserURL(source, "https://www.multitheftauto.com/")
+end)
+
+local lastBrowser = nil
+addEventHandler("onClientBrowserResourceBlocked", theBrowser, function(url, domain, reason)
+  if (reason == 0) then
+    
+    lastBrowser = source
+    requestBrowserDomains({domain}, false, function(accepted, newDomains)
+      if (accepted == true) then
+        reloadBrowserPage(lastBrowser)
+      end
+      lastBrowser = nil
+    end)
+  
+  end
+end)

events/Browser/examples/onClientBrowserResourceBlocked-2.lua

@@ -0,0 +1,6 @@
+function resourceBlocked(url,domain,reason)
+    if reason == 0 then
+        requestBrowserDomains({domain})
+    end
+end
+addEventHandler("onClientBrowserResourceBlocked",browserElement,resourceBlocked)

events/Browser/examples/onClientBrowserTooltip-1.lua

@@ -0,0 +1,16 @@
+local browser = guiCreateBrowser(0, 0, 800, 600, false, false, false)
+local theBrowser = guiGetBrowser(browser)
+showCursor(true)
+
+
+addEventHandler( "onClientBrowserCreated", theBrowser, function()
+  loadBrowserURL(source, "https://www.google.com/?ncr&hl=en")
+end)
+
+addEventHandler("onClientBrowserTooltip", root, function(text)
+  if (text ~= "") then
+    outputChatBox("Tooltip-Text: "..text)
+  else
+    outputChatBox("You are not longer hovering a tooltip")
+  end
+end)

events/Browser/examples/onClientBrowserWhitelistChange-1.lua

@@ -0,0 +1,10 @@
+requestBrowserDomains({ "mtasa.com" }) -- request browser domain
+showCursor(true) -- show cursor
+addEventHandler("onClientBrowserWhitelistChange", root,
+   function(newDomains)
+     if newDomains[1] == "mtasa.com" then
+       local browser = createBrowser(1280, 720, false, false) -- create browser
+       loadBrowserURL(browser, "http://mtasa.com/") -- load browser url
+   end
+end
+)

events/Browser/onClientBrowserCreated.yaml

@@ -9,3 +9,7 @@ description: This event is triggered when the CEF browser instance has been crea
   "CreateBrowser") or [guiCreateBrowser](/wiki/GuiCreateBrowser "GuiCreateBrowser")),
   this event will be the convenient place.
 parameters: []
+examples:
+- path: examples/onClientBrowserCreated-1.lua
+  description: ''
+  side: client

events/Browser/onClientBrowserCursorChange.yaml

@@ -10,3 +10,7 @@ parameters:
 - name: cursorId
   type: int
   description: The new cursor ID. See Cursor IDs.
+examples:
+- path: examples/onClientBrowserCursorChange-1.lua
+  description: ''
+  side: client

events/Browser/onClientBrowserDocumentReady.yaml

@@ -9,3 +9,7 @@ parameters:
 - name: url
   type: string
   description: the url of the web page loaded.
+examples:
+- path: examples/onClientBrowserDocumentReady-1.lua
+  description: ''
+  side: client

events/Browser/onClientBrowserInputFocusChanged.yaml

@@ -9,3 +9,4 @@ parameters:
 - name: gainedFocus
   type: bool
   description: true if an input field has been focused, false if it has lost focus.
+examples: []

events/Browser/onClientBrowserLoadingFailed.yaml

@@ -15,3 +15,7 @@ parameters:
 - name: errorDescription
   type: string
   description: a short description.
+examples:
+- path: examples/onClientBrowserLoadingFailed-1.lua
+  description: ''
+  side: client

events/Browser/onClientBrowserLoadingStart.yaml

@@ -15,3 +15,7 @@ parameters:
   description: 'a boolean representing whether the entire page (main frame) was loaded
     or an <iframe> inside the page was loaded. true: If the URL is loaded in the main
     frame. false: If the URL is loaded in a <iframe>.'
+examples:
+- path: examples/onClientBrowserLoadingStart-1.lua
+  description: ''
+  side: client

events/Browser/onClientBrowserNavigate.yaml

@@ -18,3 +18,7 @@ parameters:
   type: bool
   description: a boolean representing whether the entire page (main frame) was loaded
     or an <iframe> inside the page was loaded.
+examples:
+- path: examples/onClientBrowserNavigate-1.lua
+  description: ''
+  side: client

events/Browser/onClientBrowserPopup.yaml

@@ -15,3 +15,7 @@ parameters:
 - name: isPopup
   type: bool
   description: ''
+examples:
+- path: examples/onClientBrowserPopup-1.lua
+  description: ''
+  side: client

events/Browser/onClientBrowserResourceBlocked.yaml

@@ -22,3 +22,16 @@ parameters:
     1: blacklisted
 
     2: blocked protocol scheme'
+examples:
+- path: examples/onClientBrowserResourceBlocked-1.lua
+  description: This example asks the user to accept a blocked resource and reloads
+    the browser if accepted.
+  side: client
+- path: examples/onClientBrowserResourceBlocked-2.lua
+  description: 'This example sends whitelist requests on demand, which means whenever
+    a blocked domain is detected/queried by the user.
+
+    It''s also a good alternative to requesting CEF domains on server join, because
+    this is less intrusive and requests will only be sent as soon the player starts
+    interacting with a browser script.'
+  side: client

events/Browser/onClientBrowserTooltip.yaml

@@ -10,3 +10,8 @@ parameters:
   type: string
   description: string containing the tooltip text. Empty string if user is not longer
     hovering.
+examples:
+- path: examples/onClientBrowserTooltip-1.lua
+  description: 'If the user hovers the Google search input field ''Tooltip-Text: Search''
+    will be printed in the chatbox.'
+  side: client

events/Browser/onClientBrowserWhitelistChange.yaml

@@ -10,3 +10,7 @@ parameters:
 - name: changedDomains
   type: table
   description: a table of changed domains.
+examples:
+- path: examples/onClientBrowserWhitelistChange-1.lua
+  description: ''
+  side: client

events/Client/examples/onConsole-1.lua

@@ -0,0 +1,17 @@
+function input_Console ( text ) --when a player types in the console
+	-- if it's an ingame player,
+	if ( getElementType ( source ) == "player" ) then
+		--split the command by spaces (ASCII 32) and get the first piece of text
+		local command = gettok ( text, 1, 32 )
+		--if the first piece of text was "yo",
+		if ( command == "yo" ) then
+			--get the player's name
+			local playerName = getPlayerName ( source )
+			-- get the action text by substracting the first three characters ("yo ")
+			local actionText = string.sub ( text, 3 )
+			-- announce the yo command into the chatbox
+			outputChatBox ( "* " .. playerName .. " " .. actionText, getRootElement(), 255, 255, 0 )
+		end
+	end
+end
+addEventHandler ( "onConsole", getRootElement(), input_Console ) -- add an event handler for onConsole

events/Client/onConsole.yaml

@@ -11,3 +11,7 @@ parameters:
 - name: theMessage
   type: string
   description: a string representing the message entered into the console.
+examples:
+- path: examples/onConsole-1.lua
+  description: ''
+  side: server

events/Colshape/examples/onClientColShapeHit-1.lua

@@ -0,0 +1,6 @@
+function onClientColShapeHit( theElement, matchingDimension )
+    if ( theElement == localPlayer ) then  -- Checks whether the entering element is the local player
+        outputChatBox( "In." )  --Outputs.
+    end
+end
+addEventHandler("onClientColShapeHit", root, onClientColShapeHit)

events/Colshape/examples/onClientColShapeHit-2.lua

@@ -0,0 +1,10 @@
+myZone = createColSphere (2490, -1668, 12.5, 25) -- Creates a collision sphere.
+
+function dimensionChecker (theElement, matchingDimension)
+    if matchingDimension then -- Checks whether the entering element is in the same dimension as the collision shape.
+        outputChatBox ("The element is in the same dimension.")
+    else
+        outputChatBox ("The element is not in the same dimension.")
+    end
+end
+addEventHandler ("onClientColShapeHit", myZone, dimensionChecker)

events/Colshape/examples/onClientColShapeLeave-1.lua

@@ -0,0 +1,6 @@
+function onClientColShapeLeave( theElement, matchingDimension )
+    if ( theElement == localPlayer ) then  -- Checks whether the leaving element is the local player
+        outputChatBox( "Out." )  --Outputs.
+    end
+end
+addEventHandler("onClientColShapeLeave", root, onClientColShapeLeave)

events/Colshape/examples/onColShapeHit-1.lua

@@ -0,0 +1,27 @@
+-- create our hill area for our gamemode
+local hillArea = createColRectangle ( -2171.0678710938, 678.17950439453, 15, 15 )
+
+-- add hill_Enter as a handler for when a player enters the hill area
+function hill_Enter ( thePlayer, matchingDimension )
+        if getElementType ( thePlayer ) == "player" then --if the element that entered was player
+                --let's get the name of the player
+                local nameOfThePlayer = getPlayerName ( thePlayer )
+	        --announce to everyone that the player entered the hill
+	        outputChatBox ( nameOfThePlayer.." entered the zone!", root, 255, 255, 109 )
+        end
+end
+addEventHandler ( "onColShapeHit", hillArea, hill_Enter )
+
+-- add hill_Enter as a handler for when a player leaves the hill area
+function hill_Exit ( thePlayer, matchingDimension )
+        if getElementType ( thePlayer ) == "player" then --if the element that left was player
+	        --check if the player is not dead
+	        if isPlayerDead ( thePlayer ) ~= true then
+                        --let's get the name of the player
+                        local nameOfThePlayer = getPlayerName ( thePlayer )
+	        	--if he was alive, announce to everyone that the player has left the hill
+	        	outputChatBox ( nameOfThePlayer.." left the zone!", root, 255, 255, 109 )
+	        end
+        end
+end
+addEventHandler ( "onColShapeLeave", hillArea, hill_Exit )

events/Colshape/examples/onColShapeLeave-1.lua

@@ -0,0 +1,10 @@
+local jailZone = createColCircle ( 1024, 1024, 15 ) -- create a collision shape
+
+-- call 'jailZoneLeave' whenever a player leaves the collision shape:
+function jailZoneLeave ( thePlayer )
+   if getElementType ( thePlayer ) == "player" then -- if the element that left was player
+      killPlayer ( thePlayer ) -- kill the player
+      outputChatBox ( "You are not allowed to leave the jail!", thePlayer )
+   end
+end
+addEventHandler ( "onColShapeLeave", jailZone, jailZoneLeave )

events/Colshape/onClientColShapeHit.yaml

@@ -14,3 +14,12 @@ parameters:
   type: bool
   description: a boolean referring to whether the hit collision shape was in the same
     dimension as the element.
+examples:
+- path: examples/onClientColShapeHit-1.lua
+  description: This example outputs "In." to the chatbox whenever the local user enters
+    a collision shape.
+  side: client
+- path: examples/onClientColShapeHit-2.lua
+  description: This example outputs to the chatbox if the local user is in the same
+    dimension as the collision shape or not.
+  side: client

events/Colshape/onClientColShapeLeave.yaml

@@ -14,3 +14,8 @@ parameters:
   type: bool
   description: a boolean referring to whether the collision shape was in the same
     dimension as the element.
+examples:
+- path: examples/onClientColShapeLeave-1.lua
+  description: This example outputs "Out." to the chatbox whenever the local user
+    leaves a collision shape.
+  side: client

events/Colshape/onColShapeHit.yaml

@@ -15,3 +15,8 @@ parameters:
   type: bool
   description: a boolean referring to whether the hit collision shape was in the same
     dimension as the element.
+examples:
+- path: examples/onColShapeHit-1.lua
+  description: This example creates a hill area for aKing of the hillgamemode.  When
+    a player enters or leaves the area, it's announced in the chatbox.
+  side: server

events/Colshape/onColShapeLeave.yaml

@@ -16,3 +16,8 @@ parameters:
   type: bool
   description: a boolean referring to whether the collision shape was in the same
     dimension as the element.
+examples:
+- path: examples/onColShapeLeave-1.lua
+  description: 'This example kills the player whenever they leave a certain collision
+    shape:'
+  side: server