PlayerExitColshape: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
No edit summary
Line 1: Line 1:
This event is triggered when a player exits a colshape.
This event is triggered when a player exits a colshape.
Default dimension for Colshapes is 0, and the player must be in the same dimension as the Colshape for them to collide.
Default dimension for Colshapes is 0, and the player must be in the same dimension as the Colshape for them to collide.



Revision as of 14:47, 28 November 2018

This event is triggered when a player exits 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 exited the colshape
  • shape - the colshape the player left

Example

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

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

mp.events.add("playerExitColshape", playerExitColshapeHandler);


Client-Side Event

 C#  JavaScript


C# Syntax

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

Parameters

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

Example

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


JavaScript Syntax

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

function playerExitColshapeHandler(shape) {
  if(shape == someColShape) {
    //Local player left the colshape
  }
}

mp.events.add("playerExitColshape", playerExitColshapeHandler);


See also

Checkpoint

Colshape

Entity

Player

Streaming

Vehicle

Waypoint