Scraper: parse event page notes

Author: Fernando-A-Rocha

events/Browser/onClientBrowserCreated.yaml

@@ -13,3 +13,7 @@ examples:
 - path: examples/onClientBrowserCreated-1.lua
   description: ''
   side: client
+notes:
+- type: info
+  content: Calling loadBrowserURL right after createBrowser will not work normally
+    due to the nature of the asynchronous browser interface.

events/Browser/onClientBrowserWhitelistChange.yaml

@@ -14,3 +14,7 @@ examples:
 - path: examples/onClientBrowserWhitelistChange-1.lua
   description: ''
   side: client
+notes:
+- type: info
+  content: Attaching the event to a webbrowser won't work. Attach it to the root element
+    instead.

events/Client/onConsole.yaml

@@ -15,3 +15,7 @@ examples:
 - path: examples/onConsole-1.lua
   description: ''
   side: server
+notes:
+- type: info
+  content: The event will not be triggered if the message can be processed by an existing
+    command handler

events/Colshape/onClientColShapeHit.yaml

@@ -23,3 +23,7 @@ examples:
   description: This example outputs to the chatbox if the local user is in the same
     dimension as the collision shape or not.
   side: client
+notes:
+- type: info
+  content: The hit won't be detected if the element that entered the colshape is a
+    colshape or projectile.

events/Colshape/onColShapeHit.yaml

@@ -20,3 +20,7 @@ examples:
   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
+notes:
+- type: info
+  content: The hit won't be detected if the element that entered the colshape is a
+    colshape.

events/Element/onClientElementStreamIn.yaml

@@ -14,3 +14,18 @@ examples:
   description: This example shows you how to tell player that another player was streamed
     in and the distance between them and said player
   side: client
+notes:
+- type: info
+  content: This event also triggers for a remote player that dies in front of local
+    player, even if they respawn far away.. the moment they do so, this event will
+    be triggered, and if you'd measure distance between local and said remote player
+    (that spawned far away) during this event, it would output the distance at which
+    they died in front of local player, e.g 2 metres. This is bug-prone behavior and
+    likely incorrect, to be fixed in the future, but for now be aware. The 'low distance'
+    aspect of this (which could worsen your results) is caused by the split second
+    that their ped elements may 'flash' past its wasted location during the respawning
+    process. For now you can work around these side effect (both, or the distance
+    aspect.. results may vary based on randomness) by adding an isPedDead check inside
+    the event, checking source (said remote player), as this delays the onClientElementIn
+    until after full respawn has taken place. The below script example incorporates
+    this workaround

events/Element/onClientElementStreamOut.yaml

@@ -14,3 +14,8 @@ examples:
   description: This example shows you how to tell player that another player was streamed
     out and the distance between them and said player
   side: client
+notes:
+- type: info
+  content: Be aware that this event triggers for local player (as itself being the
+    element that got streamed out) when said local player dies and respawns, as this
+    is the removal & recreation of entity local ped.

events/Input/onClientClick.yaml

@@ -48,3 +48,6 @@ examples:
     displays in the position of the element telling you what kind of element you have
     clicked.  It hides after 5 seconds.
   side: client
+notes:
+- type: info
+  content: This event only triggers if the cursor is visible by showCursor

events/Input/onClientGUIClick.yaml

@@ -28,3 +28,11 @@ examples:
     the button is clicked with the left mouse button, it will output the message in
     the edit box into the chat box.
   side: client
+notes:
+- type: info
+  content: The player who clicked the gui-element is always the localPlayer .
+- type: info
+  content: If the GUI Element attached to this event has a parent element, this event
+    will be triggered once the parent element of the attached element is clicked too.
+    You can set the parameter propagate to false in the call to addEventHandler to
+    prevent this.

events/Object/onClientObjectBreak.yaml

@@ -14,3 +14,6 @@ examples:
   description: This example prevents objects from beeing broken in interiors.
   side: client
 canceling: If this event is canceled, the object will not break.
+notes:
+- type: info
+  content: This event is only triggered for objects that are streamed in

events/Object/onClientObjectDamage.yaml

@@ -20,3 +20,6 @@ examples:
   description: 'This example outputs the theoretical and real loss:'
   side: client
 canceling: If this event is canceled, the object will not be damaged.
+notes:
+- type: info
+  content: This event is only triggered for objects that are streamed in.

events/Other/onClientMinimize.yaml

@@ -10,3 +10,8 @@ examples:
 - path: examples/onClientMinimize-1.lua
   description: This example kills any player who minimizes the game.
   side: client
+notes:
+- type: info
+  content: This event only triggers from fullscreen minimize. onClientRestore can
+    trigger even if this event didn't. isMTAWindowFocused is a more reliable way to
+    see if a player is minimized.

events/Other/onClientWorldSound.yaml

@@ -30,3 +30,9 @@ examples:
     gets played has been played using '/seesoundlist'.
   side: client
 canceling: If this event is canceled, the sound won't play at all.
+notes:
+- type: info
+  content: Use setWorldSoundEnabled if you want to disable certain sounds conditionless.
+    For example, you should only cancel player emitted sounds in this event, because
+    when you cancel certain vehicle sounds, the game will try to play the same sound
+    on the next frame.

events/Ped/onClientPedChoke.yaml

@@ -18,3 +18,5 @@ examples:
   description: This example disables choking effects from the tear gas grenades.
   side: client
 canceling: If this event is canceled, the ped will not be choked.
+meta:
+- needs_checking: Event is never triggered

events/Ped/onClientPedDamage.yaml

@@ -24,3 +24,6 @@ examples:
   description: This example cancels any damage done to peds
   side: client
 canceling: If this event is canceled, then any damaging effects to the ped will cease.
+notes:
+- type: info
+  content: This event is only triggered for peds that are streamed in

events/Ped/onClientPedHeliKilled.yaml

@@ -15,3 +15,6 @@ examples:
   description: This example disables helicopter killing
   side: client
 canceling: If this event is canceled, the ped will not be killed
+notes:
+- type: info
+  content: This event is only triggered for peds that are streamed in

events/Ped/onClientPedHitByWaterCannon.yaml

@@ -14,3 +14,6 @@ examples:
   description: This example says who got hit by a water cannon.
   side: client
 canceling: If this event is canceled, the ped will not be knocked down
+notes:
+- type: info
+  content: This event is only triggered for peds that are streamed in

events/Ped/onClientPedStep.yaml

@@ -14,3 +14,6 @@ examples:
 - path: examples/onClientPedStep-1.lua
   description: ''
   side: client
+notes:
+- type: info
+  content: This event is only triggered for peds that are streamed in

events/Ped/onClientPedWeaponFire.yaml

@@ -32,4 +32,7 @@ examples:
 - path: examples/onClientPedWeaponFire-1.lua
   description: ''
   side: client
+notes:
+- type: info
+  content: This event is only triggered for peds that are streamed in
 incomplete: true

events/Ped/onPedDamage.yaml

@@ -17,3 +17,6 @@ examples:
   side: server
 canceling: Canceling this event has no effect. Cancel the client-side event onClientPedDamage
   instead.
+notes:
+- type: info
+  content: This event is not triggered prior to r21247.

events/Pickup/onPickupUse.yaml

@@ -18,3 +18,6 @@ examples:
   side: server
 canceling: If this event is canceled, the player will not be given the item they picked
   up.
+notes:
+- type: tip
+  content: '[[{{{image}}}|link=|]]'

events/Player/onClientPlayerDamage.yaml

@@ -27,3 +27,6 @@ examples:
   side: client
 canceling: If this event is canceled, then any damaging effects to the local player
   will cease.
+notes:
+- type: info
+  content: This event is only triggered for players that are streamed in

events/Player/onClientPlayerHeliKilled.yaml

@@ -15,3 +15,6 @@ examples:
   description: This example disables helicopter killing
   side: client
 canceling: If this event is canceled, the player will not be killed
+notes:
+- type: info
+  content: This event is only triggered for players that are streamed in

events/Player/onClientPlayerHitByWaterCannon.yaml

@@ -14,3 +14,6 @@ examples:
   description: This example outputs a message when you are hit by a water cannon
   side: client
 canceling: If this event is canceled, the player will not be knocked down.
+notes:
+- type: info
+  content: This event is only triggered for players that are streamed in

events/Player/onClientPlayerVoiceStart.yaml

@@ -12,3 +12,8 @@ examples:
   description: This example outputs to the console the player that started talking.
   side: client
 canceling: This example outputs to the console the player that started talking.
+notes:
+- type: info
+  content: This event triggers inconsistently ( https://github.com/multitheftauto/mtasa-blue/issues/1700
+    ). You should use onPlayerVoiceStart and trigger a custom client-sided event to
+    get similar results, minus the cancelEvent effect.

events/Player/onClientPlayerVoiceStop.yaml

@@ -12,3 +12,8 @@ examples:
   description: This example outputs to the console the player that stopped talking.
   side: client
 canceling: This example outputs to the console the player that stopped talking.
+notes:
+- type: info
+  content: This event triggers inconsistently ( https://github.com/multitheftauto/mtasa-blue/issues/1700
+    ). You should use onPlayerVoiceStart and trigger a custom client-sided event to
+    get similar results, minus the cancelEvent effect.

events/Player/onClientPlayerWeaponFire.yaml

@@ -50,4 +50,10 @@ examples:
 - path: examples/onClientPlayerWeaponFire-3.lua
   description: This example makes the Shotgun fire explosive rounds.
   side: client
+notes:
+- type: info
+  content: This event is only triggered for players that are streamed in
+- type: info
+  content: This does not trigger for any player's melee weapons or for remote player's
+    projectile weapons or cameras
 incomplete: true

events/Player/onPlayerACInfo.yaml

@@ -38,3 +38,7 @@ examples:
     In order for this to work, it''s important that youdon''tadd SD #14 detection
     into mtaserver.conf, as this is a custom re-implementation.'
   side: server
+notes:
+- type: info
+  content: Any resource using this event should call resendPlayerACInfo for each player
+    in onResourceStart

events/Player/onPlayerCommand.yaml

@@ -20,3 +20,10 @@ examples:
 - path: examples/onPlayerCommand-2.lua
   description: Time limit specific commands.
   side: server
+notes:
+- type: info
+  content: This event triggers regardless of whether the command exists in a script
+    or is hardcoded. Also, typing anything in chat will execute the internal command
+    "say", so this event will be triggered on every chat message as well. Therefore
+    you should avoid excessive use of this function on busy servers, out of performance
+    considerations.

events/Player/onPlayerMarkerHit.yaml

@@ -18,3 +18,7 @@ examples:
 - path: examples/onPlayerMarkerHit-1.lua
   description: This example outputs when a player hits a marker.
   side: server
+notes:
+- type: info
+  content: This event is triggered for players only. Attaching this event to a marker
+    does nothing.

events/Player/onPlayerModInfo.yaml

@@ -42,3 +42,7 @@ examples:
   description: This example checks modified files against a list and prints a warning
     in the chatbox.
   side: server
+notes:
+- type: info
+  content: Any resource using this event should call resendPlayerModInfo for each
+    player in onResourceStart .

events/Player/onPlayerTeleport.yaml

@@ -35,3 +35,7 @@ examples:
   description: This example logs unexpected teleportation events.
   side: server
 canceling: Canceling this event has no effect.
+notes:
+- type: info
+  content: 'The sensitivity threshold can be adjusted through the player_teleport_alert
+    setting, which accepts values between 5 and 500 (default: 100).'

events/Player/onPlayerWeaponFire.yaml

@@ -37,4 +37,8 @@ examples:
 - path: examples/onPlayerWeaponFire-1.lua
   description: This code creates explosions when the source players shoots.
   side: server
+notes:
+- type: info
+  content: This event works only with weapons which have enabled bullet sync. See
+    Weapons for more information.
 incomplete: true

events/Resource/onClientResourceFileDownload.yaml

@@ -24,3 +24,7 @@ examples:
   description: 'This example will output the file''s resource name/file name/size/state
     when downloading:'
   side: client
+notes:
+- type: warning
+  content: This event is NOT related to downloadFile and onClientFileDownloadComplete
+    !

events/Resource/onResourcePreStart.yaml

@@ -15,3 +15,6 @@ examples:
   description: This code will output the name of any resource that is starting.
   side: server
 canceling: If this event is cancelled, the resource won't begin starting.
+notes:
+- type: info
+  content: This event isn't triggered within the resource starting.

events/Server/onChatMessage.yaml

@@ -19,3 +19,7 @@ examples:
 - path: examples/onChatMessage-1.lua
   description: This example outputs all chat messages to debug view.
   side: server
+notes:
+- type: info
+  content: It can be used to get the element responsible for a specific outputChatBox
+    call via the second parameter.

events/Server/onShutdown.yaml

@@ -19,3 +19,9 @@ examples:
   description: ''
   side: server
 canceling: This event cannot be canceled.
+notes:
+- type: info
+  content: There is no 100% guarantee that all the code and operations executed in
+    this event will finish before the server is stopped. Therefore, avoid complex
+    actions like triggers or exports, as there may not be enough time to complete
+    the operations and execute the full code

events/Sound/onClientSoundBeat.yaml

@@ -14,3 +14,9 @@ examples:
   description: This code will change the vehicle color to a random value if the sound
     beats and the localPlayer is inside a vehicle
   side: client
+notes:
+- type: info
+  content: This event does not work correctly pre 1.3.1-9-04627
+- type: info
+  content: This event is triggered ahead of a sound beat the number passed is the
+    play time at which the beat occurs

events/Vehicle/onClientVehicleCollision.yaml

@@ -50,4 +50,7 @@ examples:
 - path: examples/onClientVehicleCollision-2.lua
   description: ''
   side: client
+notes:
+- type: info
+  content: This event is only triggered for vehicles that are streamed in
 incomplete: true

events/Vehicle/onClientVehicleDamage.yaml

@@ -40,3 +40,6 @@ examples:
   side: client
 canceling: If this event is canceled, the vehicle health won't be reduced. Physical
   damage to the vehicle will remain.
+notes:
+- type: info
+  content: This event is only triggered for vehicles that are streamed in

events/Vehicle/onClientVehicleExplode.yaml

@@ -10,3 +10,6 @@ examples:
 - path: examples/onClientVehicleExplode-1.lua
   description: This example will output some text to chat on vehicle explosion
   side: client
+notes:
+- type: info
+  content: This event can not be cancelled.

events/Vehicle/onClientVehicleNitroStateChange.yaml

@@ -13,3 +13,6 @@ examples:
 - path: examples/onClientVehicleNitroStateChange-1.lua
   description: ''
   side: client
+notes:
+- type: info
+  content: This event is only triggered for vehicles that are streamed in

events/Vehicle/onClientVehicleWeaponHit.yaml

@@ -31,3 +31,6 @@ examples:
 - path: examples/onClientVehicleWeaponHit-1.lua
   description: ''
   side: client
+notes:
+- type: info
+  content: This event is only triggered for elements that are streamed in

events/Vehicle/onTrailerAttach.yaml

@@ -17,3 +17,9 @@ examples:
     if you do not want people attaching trailers to vehicles
   side: server
 canceling: If this event is canceled, the trailer will detach from the truck again.
+notes:
+- type: warning
+  content: Doesn't appear to work.
+meta:
+- needs_checking: Cancellation of event has no effect. detachTrailerFromVehicle in
+    the event doesn't work either, 50 ms timer is effective.

events/Vehicle/onVehicleExplode.yaml

@@ -19,3 +19,6 @@ examples:
 - path: examples/onVehicleExplode-2.lua
   description: 'Example 2:This will show the name of any vehicle that blew up:'
   side: server
+notes:
+- type: info
+  content: This event can not be canceled.

events/Weapon_creation/onClientWeaponFire.yaml

@@ -42,3 +42,9 @@ examples:
   description: This example prevents player damage from custom weapons.
   side: client
 canceling: If this event was canceled, then the weapon will not fire.
+notes:
+- type: info
+  content: This event is ONLY for custom weapons that were created with createWeapon
+    , for regular weapons use onClientPlayerWeaponFire .
+- type: info
+  content: This event is only triggered for custom weapons that are streamed in