Legacy Documentation: Version 5.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Display.RelativeMouseAt

public static Vector3 RelativeMouseAt(Vector3 inputMouseCoordinates);

Parameters

inputMouseCoordinates Mouse Input Position as Coordinates.

Description

Query relative mouse coordinates.

RelativeMouseAt can be used to query relative mouse input coordinates and the screen in which Mouse Input is recorded. This is only valid on the Windows Desktop platforms with Multiple Displays. x, y returns the coordinates in relative space and z returns the screen in which Mouse Input is handled.