Scraper: parse event parameters & canceling

All events parsed

Author: Fernando-A-Rocha

events/Account/onAccountCreate.yaml

@@ -1,8 +1,13 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/onAccountCreate
+# Scraped from: https://wiki.multitheftauto.com/wiki/OnAccountCreate
 name: onAccountCreate
 type: server
-description: TODO
-incomplete: true
 source_element:
   type: element
-  description: TODO
+  description: The source of this event is the root element.
+description: This event is triggered every time an [account](/wiki/Account "Account")
+  is created
+parameters:
+- name: theAccount
+  type: account
+  description: An account element that was created
+canceling: This event cannot be canceled.

events/Account/onAccountDataChange.yaml

@@ -1,8 +1,18 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/onAccountDataChange
+# Scraped from: https://wiki.multitheftauto.com/wiki/OnAccountDataChange
 name: onAccountDataChange
 type: server
-description: TODO
-incomplete: true
 source_element:
   type: element
-  description: TODO
+  description: The source of this event is the root element.
+description: This event is triggered when an accounts data changes through [setAccountData](/wiki/SetAccountData
+  "SetAccountData").
+parameters:
+- name: theAccount
+  type: account
+  description: the account that had data changed.
+- name: theKey
+  type: string
+  description: the string key that is being changed.
+- name: theValue
+  type: string
+  description: the value it is changing to.

events/Account/onAccountRemove.yaml

@@ -1,8 +1,13 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/onAccountRemove
+# Scraped from: https://wiki.multitheftauto.com/wiki/OnAccountRemove
 name: onAccountRemove
 type: server
-description: TODO
-incomplete: true
 source_element:
   type: element
-  description: TODO
+  description: The source of this event is the root element.
+description: This event is triggered every time an [account](/wiki/Account "Account")
+  is removed
+parameters:
+- name: theAccount
+  type: account
+  description: An account element that was removed
+canceling: This event cannot be canceled.

events/Browser/onClientBrowserCreated.yaml

@@ -1,8 +1,11 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserCreated
+# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserCreated
 name: onClientBrowserCreated
 type: client
-description: TODO
-incomplete: true
 source_element:
   type: element
-  description: TODO
+  description: The browser element.
+description: This event is triggered when the CEF browser instance has been created.
+  If you want to load a specific website right after creating the browser (using [createBrowser](/wiki/CreateBrowser
+  "CreateBrowser") or [guiCreateBrowser](/wiki/GuiCreateBrowser "GuiCreateBrowser")),
+  this event will be the convenient place.
+parameters: []

events/Browser/onClientBrowserCursorChange.yaml

@@ -1,8 +1,12 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserCursorChange
+# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserCursorChange
 name: onClientBrowserCursorChange
 type: client
-description: TODO
-incomplete: true
 source_element:
   type: element
-  description: TODO
+  description: The source of this event is the browser element the cursor change occured
+    in.
+description: This event is triggered when the cursor changes within a browser window.
+parameters:
+- name: cursorId
+  type: int
+  description: The new cursor ID. See Cursor IDs.

events/Browser/onClientBrowserDocumentReady.yaml

@@ -1,8 +1,11 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserDocumentReady
+# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserDocumentReady
 name: onClientBrowserDocumentReady
 type: client
-description: TODO
-incomplete: true
 source_element:
   type: element
-  description: TODO
+  description: The browser element.
+description: This event is executed after the web page has been loaded successfully.
+parameters:
+- name: url
+  type: string
+  description: the url of the web page loaded.

events/Browser/onClientBrowserInputFocusChanged.yaml

@@ -1,8 +1,11 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserInputFocusChanged
+# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserInputFocusChanged
 name: onClientBrowserInputFocusChanged
 type: client
-description: TODO
-incomplete: true
 source_element:
   type: element
-  description: TODO
+  description: The browser element.
+description: This event is triggered when the input focus inside a browser has changed.
+parameters:
+- name: gainedFocus
+  type: bool
+  description: true if an input field has been focused, false if it has lost focus.

events/Browser/onClientBrowserLoadingFailed.yaml

@@ -1,8 +1,17 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserLoadingFailed
+# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserLoadingFailed
 name: onClientBrowserLoadingFailed
 type: client
-description: TODO
-incomplete: true
 source_element:
   type: element
-  description: TODO
+  description: The browser element.
+description: The event is triggered when the browser can not load the page.
+parameters:
+- name: url
+  type: string
+  description: the requested URL.
+- name: errorCode
+  type: int
+  description: see error codes below.
+- name: errorDescription
+  type: string
+  description: a short description.

events/Browser/onClientBrowserLoadingStart.yaml

@@ -1,8 +1,17 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserLoadingStart
+# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserLoadingStart
 name: onClientBrowserLoadingStart
 type: client
-description: TODO
-incomplete: true
 source_element:
   type: element
-  description: TODO
+  description: The webbrowser element.
+description: The event is triggered when a [webbrowser](/wiki/Browser "Browser") starts
+  loading a page.
+parameters:
+- name: URL
+  type: string
+  description: string containing the URL that will be loaded.
+- name: isMainFrame
+  type: boolean
+  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>.'

events/Browser/onClientBrowserNavigate.yaml

@@ -1,8 +1,20 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserNavigate
+# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserNavigate
 name: onClientBrowserNavigate
 type: client
-description: TODO
-incomplete: true
 source_element:
   type: element
-  description: TODO
+  description: The browser element.
+description: The event is executed when the browser loads a new page. Do not use [loadBrowserURL](/wiki/LoadBrowserURL
+  "LoadBrowserURL") in the attached function.
+parameters:
+- name: targetURL
+  type: string
+  description: the page the browser loaded.
+- name: isBlocked
+  type: bool
+  description: if the browser was created with isLocal set to true, and the browser
+    tried to load a remote page, this would be set to true (and vice-versa).
+- name: isMainFrame
+  type: bool
+  description: a boolean representing whether the entire page (main frame) was loaded
+    or an <iframe> inside the page was loaded.