PlayerEnterColshape

This event is triggered when a player enters a colshape.

Default dimension for Colshapes is 0, and the player must be in the same dimension as the Colshape for them to collide.

Server-Side

Event

C#	JavaScript

JavaScript Syntax

Parameters

• player - player which entered the colshape
• shape - the colshape the player entered

Example

let someColShape = mp.colshapes.newRectangle(0, 0, 100, 100);

function playerEnterColshapeHandler(player, shape) {
  if(shape == someColShape) {
    console.log(`${player.name} entered the colshape`);
  }
}

mp.events.add("playerEnterColshape", playerEnterColshapeHandler);

Client-Side Event

C#	JavaScript

C# Syntax

public delegate void OnPlayerEnterColshapeDelegate(Colshape colshape, CancelEventArgs cancel);

Parameters

• colshape: colshape, expects RAGE.Elements.Colshape type.
• cancel: cancel, expects RAGE.Events.CancelEventArgs type.

Example

Events.OnPlayerEnterColshape += OnPlayerEnterColshape;

public void OnPlayerEnterColshape(RAGE.Elements.Colshape colshape, RAGE.Events.CancelEventArgs cancel)
{
    RAGE.Chat.Output($"You entered colshape id:{colshape.Id}");
}

JavaScript Syntax

mp.events.add('playerEnterColshape', (shape) => {
    mp.game.graphics.notify(`You entered a colshape with id "${shape.id}".`);
});

See also

Checkpoint

• playerEnterCheckpoint
• playerExitCheckpoint

Colshape

• playerEnterColshape
• playerExitColshape

Entity

• entityCreated
• entityDestroyed
• entityModelChange

Player

• playerChat
• playerCommand
• playerDamage
• playerDeath
• playerJoin
• playerQuit
• playerReady
• playerSpawn
• playerWeaponChange

Streaming

• playerStreamIn
• playerStreamOut

Vehicle

• playerStartEnterVehicle
• playerEnterVehicle
• playerStartExitVehicle
• playerExitVehicle
• trailerAttached
• vehicleDamage
• vehicleDeath
• vehicleHornToggle
• vehicleSirenToggle

Waypoint

• playerCreateWaypoint
• playerReachWaypoint