PlayerEnterColshape: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
 
(21 intermediate revisions by 7 users not shown)
Line 1: Line 1:
This event is triggered when a player enters a colshape.
This event is triggered when a player enters a colshape.  


==Parameters==
Default dimension for Colshapes is 0, and the player must be in the same dimension as the Colshape for them to collide.
* '''player''' - player which entered the colshape
{{ServersideCsJsEvent}}
* '''shape''' - the colshape the player entered


==Example==
{{CSharpContainer|1=
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
See [[OnPlayerEnterColShape]].
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
}}
<syntaxhighlight lang="javascript">
 
{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - The [[:Category:Player API|player]] which entered the colshape
* '''shape''': {{RageType|ColShape}} - The [[:Category:ColShape API|colshape]] the player entered
 
{{Example}}
<pre>
let someColShape = mp.colshapes.newRectangle(0, 0, 100, 100);
let someColShape = mp.colshapes.newRectangle(0, 0, 100, 100);


Line 18: Line 24:


mp.events.add("playerEnterColshape", playerEnterColshapeHandler);
mp.events.add("playerEnterColshape", playerEnterColshapeHandler);
</pre>
}}
{{ClientsideCsJsEvent}}
{{CSharpContainer|
<syntaxhighlight lang="c#">
public delegate void OnPlayerEnterColshapeDelegate(Colshape colshape, CancelEventArgs cancel);
</syntaxhighlight>
</syntaxhighlight>
</div>


{{Parameters}}
* '''colshape''': colshape, expects '''RAGE.Elements.Colshape''' type.
* '''cancel''': cancel, expects '''RAGE.Events.CancelEventArgs''' type.
{{Example}}
<syntaxhighlight lang="csharp">
Events.OnPlayerEnterColshape += OnPlayerEnterColshape;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerEnterColshape(RAGE.Elements.Colshape colshape, RAGE.Events.CancelEventArgs cancel)
{
    RAGE.Chat.Output($"You entered colshape id:{colshape.Id}");
}
</syntaxhighlight>
}}


<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
{{JSContainer|
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
{{Parameters}}
<syntaxhighlight lang="javascript">
* '''shape''': {{RageType|ColShape}}
// Create it serverside as follow
let someColShape = mp.colshapes.newRectangle(0, 0, 100, 100);


// Use this clientside
{{Example}}
<pre>
mp.events.add('playerEnterColshape', (shape) => {
mp.events.add('playerEnterColshape', (shape) => {
    let local = mp.players.local;
     mp.game.graphics.notify(`You entered a colshape with id "${shape.id}".`);
   
     mp.game.graphics.notify(`${local.name} entered a colshape.`);
});
});
</syntaxhighlight>
</pre>
</div>
}}


==See also==
=See also=
{{Player_events}}
{{Player_events}}
[[Category:Player]]
[[Category:ColShape]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

Latest revision as of 12:04, 1 May 2024

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




C# Syntax


JavaScript Syntax

Parameters

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

Parameters

  • shape: ColShape

Example

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


See also

Checkpoint

Colshape

Entity

Player

Streaming

Vehicle

Waypoint

Retrieved from "https://wiki.rage.mp/w/index.php?title=PlayerEnterColshape&oldid=22562"