EntityCreated: Difference between revisions
m (Replaced HTML with template) |
No edit summary |
||
| Line 1: | Line 1: | ||
This event is triggered when an Entity Is Created. From my testing, this event is only accessible on the serverside. | This event is triggered when an Entity Is Created. From my testing, this event is only accessible on the serverside. | ||
{{ServersideCsJsEvent}} | |||
{{JSContainer| | |||
{{Parameters}} | |||
* '''entity''' - the entity that was created | * '''entity''' - the entity that was created | ||
{{Example}} | |||
{{ | |||
<pre> | <pre> | ||
function entityCreatedHandler(entity) { | function entityCreatedHandler(entity) { | ||
| Line 13: | Line 13: | ||
mp.events.add("entityCreated", entityCreatedHandler); | mp.events.add("entityCreated", entityCreatedHandler); | ||
</pre> | </pre> | ||
}} | |||
{{ClientsideCsEvent}} | |||
{{CSharpContainer| | |||
<syntaxhighlight lang="c#"> | |||
public delegate void OnEntityCreatedDelegate(Entity entity); | |||
</syntaxhighlight> | |||
{{Parameters}} | |||
* '''entity''' - the streamed in entity, expects'''RAGE.Elements.Entity''' | |||
{{Example}} | |||
The example below sends a message to client when an entity comes within stream range, showing the entity model, position and remoteId. | |||
<syntaxhighlight lang="c#"> | |||
Events.OnEntityCreated += OnEntityCreated; | |||
</syntaxhighlight> | |||
<syntaxhighlight lang="c#"> | |||
public void OnEntityCreated(RAGE.Elements.Entity entity) | |||
{ | |||
RAGE.Chat.Output($"{entity.Model} created at {entity.Position} with serverside id:{entity.RemoteId}"); | |||
} | |||
</syntaxhighlight> | |||
}} | }} | ||
==See also== | ==See also== | ||
{{Player_events}} | {{Player_events}} | ||
Revision as of 14:31, 29 November 2018
This event is triggered when an Entity Is Created. From my testing, this event is only accessible on the serverside.
Server-Side Event
 C#
|
 JavaScript
|
|---|
JavaScript Syntax
Parameters
- entity - the entity that was created
Example
function entityCreatedHandler(entity) {
console.log(`An Entity with the ID of ${entity.id} was created at ${entity.position}`);
}
mp.events.add("entityCreated", entityCreatedHandler);
Client-Side Event
| C#
|
|---|
C# Syntax
public delegate void OnEntityCreatedDelegate(Entity entity);
Parameters
- entity - the streamed in entity, expectsRAGE.Elements.Entity
Example
The example below sends a message to client when an entity comes within stream range, showing the entity model, position and remoteId.
Events.OnEntityCreated += OnEntityCreated;
public void OnEntityCreated(RAGE.Elements.Entity entity)
{
RAGE.Chat.Output($"{entity.Model} created at {entity.Position} with serverside id:{entity.RemoteId}");
}
See also
Checkpoint
Colshape
Entity
Player
- playerChat
- playerCommand
- playerDamage
- playerDeath
- playerJoin
- playerQuit
- playerReady
- playerSpawn
- playerWeaponChange
Streaming
Vehicle
- playerStartEnterVehicle
- playerEnterVehicle
- playerStartExitVehicle
- playerExitVehicle
- trailerAttached
- vehicleDamage
- vehicleDeath
- vehicleHornToggle
- vehicleSirenToggle