Latest revision as of 11:06, 30 April 2019

This event is called everytime a entity goes out of player's streaming range.

Client-Side Event

C#	JavaScript

C# Syntax

public delegate void OnEntityStreamOutDelegate(Entity entity);

Parameters

entity - the streamed entity, expects RAGE.Elements.Entity

Example

The example below sends a message to client when an entity leave the stream range, showing the entity model, position and remoteId.

Events.OnEntityStreamOut += OnEntityStreamOut;

public void OnEntityStreamOut(RAGE.Elements.Entity entity)
{
    RAGE.Chat.Output($"{entity.Model} streamed out at {entity.Position} with serverside id:{entity.RemoteId}");
}

JavaScript Syntax

mp.events.add('entityStreamOut', (entity) => {});

Parameters

entity: The entity handler, output expects any type.

Example

The example below shows up a message for a player when an entity streams out.

mp.events.add('entityStreamOut', (entity) => {
    mp.gui.chat.push('Entity is gone, but never gonna give you up, never gonna let you down...');
});

@@ Line 1: / Line 1: @@
-{{ClientSide}}
+This event is called everytime a entity goes out of player's streaming range.
-This event is called everytime a entity goes out of player's streaming range.
+{{ClientsideCsJsEvent}}
+{{CSharpContainer|
+<syntaxhighlight lang="c#">
+public delegate void OnEntityStreamOutDelegate(Entity entity);
+</syntaxhighlight>
+{{Parameters}}
+* '''entity''' - the streamed entity, expects '''RAGE.Elements.Entity'''
-== Syntax ==
+{{Example}}
+The example below sends a message to client when an entity leave the stream range, showing the entity model, position and remoteId.
+<syntaxhighlight lang="c#">
+Events.OnEntityStreamOut += OnEntityStreamOut;
+</syntaxhighlight>
+<syntaxhighlight lang="c#">
+public void OnEntityStreamOut(RAGE.Elements.Entity entity)
+{
+    RAGE.Chat.Output($"{entity.Model} streamed out at {entity.Position} with serverside id:{entity.RemoteId}");
+}
+</syntaxhighlight>
+}}
+{{JSContainer|
 <syntaxhighlight lang="javascript">
 mp.events.add('entityStreamOut', (entity) => {});
 </syntaxhighlight>
-=== Parameters ===
+{{Parameters}}
-* '''entity''': The entity handler, output expects <span style="color: #408DAE"><b>any</b></span> type.
+* '''entity''': The entity handler, output expects '''any''' type.
-== Examples ==
+{{Example}}
 The example below shows up a message for a player when an entity streams out.
 <syntaxhighlight lang="javascript">
-mp.events.add('playerResurrect', () => {
+mp.events.add('entityStreamOut', (entity) => {
      mp.gui.chat.push('Entity is gone, but never gonna give you up, never gonna let you down...');
 });
 </syntaxhighlight>
+}}
+[[Category:Entity API]]
+[[Category:Client-side Event]]