Skip to content

Commit 8cde59c

Browse files
Fernando-A-RochaFernando-A-Rocha
committed
Scraper: parse event parameters & canceling
All events parsed
1 parent c461ee7 commit 8cde59c

File tree

222 files changed

+3110
-1001
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

222 files changed

+3110
-1001
lines changed

‎events/Account/onAccountCreate.yaml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onAccountCreate
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnAccountCreate
22
name: onAccountCreate
33
type: server
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The source of this event is the root element.
7+
description: This event is triggered every time an [account](/wiki/Account "Account")
8+
is created
9+
parameters:
10+
- name: theAccount
11+
type: account
12+
description: An account element that was created
13+
canceling: This event cannot be canceled.

‎events/Account/onAccountDataChange.yaml

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onAccountDataChange
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnAccountDataChange
22
name: onAccountDataChange
33
type: server
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The source of this event is the root element.
7+
description: This event is triggered when an accounts data changes through [setAccountData](/wiki/SetAccountData
8+
"SetAccountData").
9+
parameters:
10+
- name: theAccount
11+
type: account
12+
description: the account that had data changed.
13+
- name: theKey
14+
type: string
15+
description: the string key that is being changed.
16+
- name: theValue
17+
type: string
18+
description: the value it is changing to.

‎events/Account/onAccountRemove.yaml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onAccountRemove
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnAccountRemove
22
name: onAccountRemove
33
type: server
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The source of this event is the root element.
7+
description: This event is triggered every time an [account](/wiki/Account "Account")
8+
is removed
9+
parameters:
10+
- name: theAccount
11+
type: account
12+
description: An account element that was removed
13+
canceling: This event cannot be canceled.

‎events/Browser/onClientBrowserCreated.yaml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserCreated
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserCreated
22
name: onClientBrowserCreated
33
type: client
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The browser element.
7+
description: This event is triggered when the CEF browser instance has been created.
8+
If you want to load a specific website right after creating the browser (using [createBrowser](/wiki/CreateBrowser
9+
"CreateBrowser") or [guiCreateBrowser](/wiki/GuiCreateBrowser "GuiCreateBrowser")),
10+
this event will be the convenient place.
11+
parameters: []

‎events/Browser/onClientBrowserCursorChange.yaml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserCursorChange
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserCursorChange
22
name: onClientBrowserCursorChange
33
type: client
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The source of this event is the browser element the cursor change occured
7+
in.
8+
description: This event is triggered when the cursor changes within a browser window.
9+
parameters:
10+
- name: cursorId
11+
type: int
12+
description: The new cursor ID. See Cursor IDs.

‎events/Browser/onClientBrowserDocumentReady.yaml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserDocumentReady
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserDocumentReady
22
name: onClientBrowserDocumentReady
33
type: client
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The browser element.
7+
description: This event is executed after the web page has been loaded successfully.
8+
parameters:
9+
- name: url
10+
type: string
11+
description: the url of the web page loaded.

‎events/Browser/onClientBrowserInputFocusChanged.yaml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserInputFocusChanged
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserInputFocusChanged
22
name: onClientBrowserInputFocusChanged
33
type: client
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The browser element.
7+
description: This event is triggered when the input focus inside a browser has changed.
8+
parameters:
9+
- name: gainedFocus
10+
type: bool
11+
description: true if an input field has been focused, false if it has lost focus.

‎events/Browser/onClientBrowserLoadingFailed.yaml

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserLoadingFailed
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserLoadingFailed
22
name: onClientBrowserLoadingFailed
33
type: client
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The browser element.
7+
description: The event is triggered when the browser can not load the page.
8+
parameters:
9+
- name: url
10+
type: string
11+
description: the requested URL.
12+
- name: errorCode
13+
type: int
14+
description: see error codes below.
15+
- name: errorDescription
16+
type: string
17+
description: a short description.

‎events/Browser/onClientBrowserLoadingStart.yaml

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserLoadingStart
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserLoadingStart
22
name: onClientBrowserLoadingStart
33
type: client
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The webbrowser element.
7+
description: The event is triggered when a [webbrowser](/wiki/Browser "Browser") starts
8+
loading a page.
9+
parameters:
10+
- name: URL
11+
type: string
12+
description: string containing the URL that will be loaded.
13+
- name: isMainFrame
14+
type: boolean
15+
description: 'a boolean representing whether the entire page (main frame) was loaded
16+
or an <iframe> inside the page was loaded. true: If the URL is loaded in the main
17+
frame. false: If the URL is loaded in a <iframe>.'

‎events/Browser/onClientBrowserNavigate.yaml

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserNavigate
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserNavigate
22
name: onClientBrowserNavigate
33
type: client
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The browser element.
7+
description: The event is executed when the browser loads a new page. Do not use [loadBrowserURL](/wiki/LoadBrowserURL
8+
"LoadBrowserURL") in the attached function.
9+
parameters:
10+
- name: targetURL
11+
type: string
12+
description: the page the browser loaded.
13+
- name: isBlocked
14+
type: bool
15+
description: if the browser was created with isLocal set to true, and the browser
16+
tried to load a remote page, this would be set to true (and vice-versa).
17+
- name: isMainFrame
18+
type: bool
19+
description: a boolean representing whether the entire page (main frame) was loaded
20+
or an <iframe> inside the page was loaded.

‎events/Browser/onClientBrowserPopup.yaml

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserPopup
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserPopup
22
name: onClientBrowserPopup
33
type: client
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
86
description: TODO
7+
description: TODO
8+
parameters:
9+
- name: targetURL
10+
type: string
11+
description: ''
12+
- name: openerURL
13+
type: string
14+
description: ''
15+
- name: isPopup
16+
type: bool
17+
description: ''

‎events/Browser/onClientBrowserResourceBlocked.yaml

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,24 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserResourceBlocked
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserResourceBlocked
22
name: onClientBrowserResourceBlocked
33
type: client
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The browser element.
7+
description: This event is executed when a resource (images, sounds etc.) has been
8+
blocked.
9+
parameters:
10+
- name: url
11+
type: string
12+
description: the blocked URL.
13+
- name: domain
14+
type: string
15+
description: the blocked domain (part of the URL).
16+
- name: reason
17+
type: int
18+
description: 'the reason why the resource was blocked. Possibles values:
19+
20+
0: not allowed yet
21+
22+
1: blacklisted
23+
24+
2: blocked protocol scheme'

‎events/Browser/onClientBrowserTooltip.yaml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserTooltip
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserTooltip
22
name: onClientBrowserTooltip
33
type: client
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The webbrowser element.
7+
description: The event is triggered when the user hovers a tooltip.
8+
parameters:
9+
- name: text
10+
type: string
11+
description: string containing the tooltip text. Empty string if user is not longer
12+
hovering.

‎events/Browser/onClientBrowserWhitelistChange.yaml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onClientBrowserWhitelistChange
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientBrowserWhitelistChange
22
name: onClientBrowserWhitelistChange
33
type: client
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The root element.
7+
description: The event is triggered when the whitelist has changed. Note that this
8+
event is only triggered if the request window was confirmed by accepting.
9+
parameters:
10+
- name: changedDomains
11+
type: table
12+
description: a table of changed domains.

‎events/Client/onConsole.yaml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onConsole
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnConsole
22
name: onConsole
33
type: server
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The source of this event is the player that entered the message in
7+
the console. This can be a player or the server console.
8+
description: This event is triggered when a player types a message into his console.
9+
It is also triggered when entering '/' commands via the chatbox.
10+
parameters:
11+
- name: theMessage
12+
type: string
13+
description: a string representing the message entered into the console.

‎events/Colshape/onClientColShapeHit.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onClientColShapeHit
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientColShapeHit
22
name: onClientColShapeHit
33
type: client
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The source of this event is the colshape that was hit.
7+
description: This event is triggered when a physical [element](/wiki/Element "Element")
8+
hits a [colshape](/wiki/Colshape "Colshape").
9+
parameters:
10+
- name: theElement
11+
type: element
12+
description: the element that entered the colshape.
13+
- name: matchingDimension
14+
type: bool
15+
description: a boolean referring to whether the hit collision shape was in the same
16+
dimension as the element.

‎events/Colshape/onClientColShapeLeave.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onClientColShapeLeave
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnClientColShapeLeave
22
name: onClientColShapeLeave
33
type: client
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The source of this event is the colshape that the element left.
7+
description: This event is triggered when a physical [element](/wiki/Element "Element")
8+
leaves a [colshape](/wiki/Colshape "Colshape").
9+
parameters:
10+
- name: theElement
11+
type: element
12+
description: the element that left the colshape.
13+
- name: matchingDimension
14+
type: bool
15+
description: a boolean referring to whether the collision shape was in the same
16+
dimension as the element.

‎events/Colshape/onColShapeHit.yaml

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onColShapeHit
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnColShapeHit
22
name: onColShapeHit
33
type: server
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The source of this event is the colshape that got hit by a player or
7+
vehicle.
8+
description: This event is triggered when a physical [element](/wiki/Element "Element")
9+
hits a [colshape](/wiki/Colshape "Colshape").
10+
parameters:
11+
- name: hitElement
12+
type: element
13+
description: the element that entered the colshape.
14+
- name: matchingDimension
15+
type: bool
16+
description: a boolean referring to whether the hit collision shape was in the same
17+
dimension as the element.

‎events/Colshape/onColShapeLeave.yaml

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
1-
# Scraped from: https://wiki.multitheftauto.com/wiki/onColShapeLeave
1+
# Scraped from: https://wiki.multitheftauto.com/wiki/OnColShapeLeave
22
name: onColShapeLeave
33
type: server
4-
description: TODO
5-
incomplete: true
64
source_element:
75
type: element
8-
description: TODO
6+
description: The source of this event is the colshape that the element no longer
7+
is in contact with.
8+
description: This event is triggered when a player or a vehicle leaves a collision
9+
shape.
10+
parameters:
11+
- name: leaveElement
12+
type: element
13+
description: The element that who exited the col shape. This can be a player or
14+
a vehicle.
15+
- name: matchingDimension
16+
type: bool
17+
description: a boolean referring to whether the collision shape was in the same
18+
dimension as the element.

0 commit comments

Comments
 (0)