Click: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
Line 1: Line 1:
{{ClientsideCsJsEvent}}
{{CSharpContainer|
<syntaxhighlight lang="c#">
public delegate void OnClickDelegate(int x, int y, bool up, bool right);
</syntaxhighlight>
{{Parameters}}
* '''x''': x expects, '''System.Int32'''
* '''y''': y expects, '''System.Int32'''
* '''up''': up expects, '''System.Boolean'''
* '''right''': right expects, '''System.Boolean'''
{{Example}}
<syntaxhighlight lang="c#">
Events.OnClick += OnClick;
</syntaxhighlight>
<syntaxhighlight lang="c#">
public void OnClick(int x, int y, bool up, bool right)
{
    //Do stuff
}
</syntaxhighlight>
}}
{{JSContainer|
This event is triggered when a player use mouse click.
This event is triggered when a player use mouse click.


==Parameters==
{{Parameters}}
* '''absoluteX: <span style="color:#008017>Number</span>'''
* '''absoluteX''': '''Number'''
* '''absoluteY: <span style="color:#008017>Number</span>'''
* '''absoluteY''': '''Number'''
* '''upOrDown: <span style="color:#008017>String</span>'''
* '''upOrDown''': '''String'''
* '''leftOrRight: <span style="color:#008017>String</span>'''
* '''leftOrRight''': '''String'''
* '''relativeX: <span style="color:#008017>Number</span>'''
* '''relativeX''': '''Number'''
* '''relativeY: <span style="color:#008017>Number</span>'''
* '''relativeY''': '''Number'''
* '''worldPosition: <span style="color:#008017>Vector3</span>'''
* '''worldPosition''': '''Vector3'''
* '''hitEntity: <span style="color:#008017>Number</span>'''
* '''hitEntity''': '''Number'''


==Example==
{{Example}}
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
mp.events.add('click', (x, y, upOrDown, leftOrRight, relativeX, relativeY, worldPosition, hitEntity) => {
mp.events.add('click', (x, y, upOrDown, leftOrRight, relativeX, relativeY, worldPosition, hitEntity) => {
Line 23: Line 49:
});
});
</syntaxhighlight>
</syntaxhighlight>
 
}}
==See also==
==See also==
{{Player_events}}
{{Player_events}}

Revision as of 14:14, 28 November 2018

Client-Side Event

 C#  JavaScript



C# Syntax

public delegate void OnClickDelegate(int x, int y, bool up, bool right);

Parameters

  • x: x expects, System.Int32
  • y: y expects, System.Int32
  • up: up expects, System.Boolean
  • right: right expects, System.Boolean

Example

Events.OnClick += OnClick;
public void OnClick(int x, int y, bool up, bool right)
{
    //Do stuff
}


JavaScript Syntax

This event is triggered when a player use mouse click.

Parameters

  • absoluteX: Number
  • absoluteY: Number
  • upOrDown: String
  • leftOrRight: String
  • relativeX: Number
  • relativeY: Number
  • worldPosition: Vector3
  • hitEntity: Number

Example

mp.events.add('click', (x, y, upOrDown, leftOrRight, relativeX, relativeY, worldPosition, hitEntity) => {
    mp.gui.chat.push("Mouse X:" + x + " | Mouse Y:" + y); // Displays mouse position on click.

    if (upOrDown == "up")
         mp.gui.chat.push("Mouse Clicked Up with " + leftOrRight + " button.");

    if (upOrDown == "down")
         mp.gui.chat.push("Mouse Clicked Down with " + leftOrRight + " button.");
});


See also

Checkpoint

Colshape

Entity

Player

Streaming

Vehicle

Waypoint