VISU - PHP Game Framework

MouseClickSignal extends Signal
in package

Table of Contents

Properties

$initialPosition  : Vec2
Position the cursor was at when the mouse button was pressed initially
$mods  : int
Bit field describing which modifier keys were held down
$position  : Vec2
Position the cursor currently is at
$travelDistance  : float
Distance the cursor has moved since the mouse button was pressed initially
$window  : Window
The window that received the event

Methods

__construct()  : mixed
Constructor
__debugInfo()  : array<string, mixed>
Omits the window property from the debug output
isPropagationStopped()  : bool
Has the propagation been stopped?
stopPropagation()  : void
Stop the propagation of the signal

Properties

$initialPosition read-only

Position the cursor was at when the mouse button was pressed initially

public Vec2 $initialPosition

$mods read-only

Bit field describing which modifier keys were held down

public int $mods

$position read-only

Position the cursor currently is at

public Vec2 $position

$travelDistance read-only

Distance the cursor has moved since the mouse button was pressed initially

public float $travelDistance

Methods

__construct()

Constructor

public __construct(Window $window, int $mods, Vec2 $position, Vec2 $initialPosition, float $travelDistance) : mixed
Parameters
$window : Window

The window that received the event

$mods : int

Bit field describing which modifier keys were held down

$position : Vec2

Position the cursor currently is at

$initialPosition : Vec2

Position the cursor was at when the mouse button was pressed initially

$travelDistance : float

Distance the cursor has moved since the mouse button was pressed initially

__debugInfo()

Omits the window property from the debug output

public __debugInfo() : array<string, mixed>
Return values
array<string, mixed>

isPropagationStopped()

Has the propagation been stopped?

public isPropagationStopped() : bool
Return values
bool

stopPropagation()

Stop the propagation of the signal

public stopPropagation() : void

        
On this page

Search results