PlayerExitColshape: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
mNo 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.


{{ServersideCsJsEvent}}
{{ServersideCsJsEvent}}
Line 11: Line 11:
{{JSContainer|
{{JSContainer|
{{Parameters}}
{{Parameters}}
* '''player''': {{RageType|Player}} - player which exited the colshape
* '''player''': {{RageType|Player}} - The [[:Category:Player API|player]] which exited the colshape
* '''shape''': {{RageType|ColShape}} - the [[:Category:ColShape API|colshape]] the player left
* '''shape''': {{RageType|ColShape}} - The [[:Category:ColShape API|colshape]] the player left


{{Example}}
{{Example}}
Line 71: Line 71:
{{Player_events}}
{{Player_events}}


[[Category:Player]]
[[Category:ColShape]]
[[Category:ColShape]]
[[Category:Server-side Event]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]
[[Category:Client-side Event]]

Revision as of 14:00, 23 May 2019

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




C# Syntax


JavaScript Syntax

Parameters

  • player: Player - The player which exited the colshape
  • shape: ColShape - 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

Parameters

  • shape: ColShape

Example

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