Latest revision as of 19:03, 15 May 2024

Client-Side Event

C#	JavaScript

C# Server-Side: OnUpdate

C# Syntax

This event is invoked every tick on the client-side

public delegate void TickDelegate(List<TickNametagData> nametags);

Parameters

nametags nametags, expects List<Events.TickNametagData> type.

Example

The below example sends the players position in chat everytime the Tick event is invoked

Events.Tick += Tick;

public void Tick(List<Events.TickNametagData> nametags)
{
    Vector3 position = nametags.Find(n => n.Player.IsLocal == true).Player.Position;
    RAGE.Chat.Output($"You are at X[{position.X}] Y[{position.Y}] Z[{position.Z}]");
}

JavaScript Syntax

This event is invoked every frame on client-side, it is not accessible on the server. It is similar to the OnUpdate in C# server-side Code where the function/event is called every tick on the server.

Parameters

nametags (Optional)

Example

mp.events.add('render', () => {
    mp.game.graphics.drawText('This is called every frame.', [0.5, 0.005], {
      font: 4,
      color: [255, 255, 255, 255],
      scale: [1.0, 1.0],
      outline: true
    });
});

Checkpoint

Colshape

Entity

Player

Streaming

Vehicle

Waypoint

@@ Line 1: / Line 1: @@
-This event is invoked every frame.
+<!-- {{ServersideCsEvent}} -->
+{{ClientsideCsJsEvent}}
+C# Server-Side: [[OnUpdate]]
+{{CSharpContainer|
+This event is invoked every tick on the client-side
+<syntaxhighlight lang="c#">
+public delegate void TickDelegate(List<TickNametagData> nametags);
+</syntaxhighlight>
+{{Parameters}}
+* '''nametags''' nametags, expects '''List<Events.TickNametagData>''' type.
+{{Example}}
+The below example sends the players position in chat everytime the Tick event is invoked
+<syntaxhighlight lang="c#">
+Events.Tick += Tick;
+</syntaxhighlight>
+<syntaxhighlight lang="c#">
+public void Tick(List<Events.TickNametagData> nametags)
+{
+    Vector3 position = nametags.Find(n => n.Player.IsLocal == true).Player.Position;
+    RAGE.Chat.Output($"You are at X[{position.X}] Y[{position.Y}] Z[{position.Z}]");
+}
+</syntaxhighlight>
+}}
-==Parameters==
+{{JSContainer|
-* '''nametags (Optional)'''
+This event is invoked every frame on client-side, it is not accessible on the server.
+It is similar to the OnUpdate in C# server-side Code where the function/event is called every tick on the server.
+{{Parameters}}
+* nametags (Optional)
-==Example==
+{{Example}}
-<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
+<pre>
-<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
-<syntaxhighlight lang="javascript">
 mp.events.add('render', () => {
-     mp.game.graphics.drawText('This is called every frame.', [0.5, 0.005],
+     mp.game.graphics.drawText('This is called every frame.', [0.5, 0.005], {
-    {
        font: 4,
        color: [255, 255, 255, 255],
@@ Line 17: / Line 40: @@
      });
 });
-</syntaxhighlight>
+</pre>
-</div>
+}}
 ==See also==
 {{Player_events}}
+[[Category:Server-side Event]]
+[[Category:Client-side Event]]