Mouse
Represents a Mouse in the environment.
Properties
| Property | Type | Default |
|---|---|---|
Icon | EnumItem | Enum.KinemiumMouseCursor.MOUSE_CURSOR_DEFAULT |
Target | any | nil |
Hit | any | nil |
UnitRay | any | nil |
TargetFilter | any | nil |
IsMouseHidden | boolean | false |
IsMouseOutOfBounds | boolean | false |
X | number | 0 |
Y | number | 0 |
ViewSizeX | number | 0 |
ViewSizeY | number | 0 |
Button1Down | any | Button1Down |
Button1Up | any | Button1Up |
Button2Down | any | Button2Down |
Button2Up | any | Button2Up |
Move | any | Move |
WheelForward | any | WheelForward |
WheelBackward | any | WheelBackward |
Name | string | "Mouse" |
Functions
`RayIntersectOBB`
`readRayCollision`
`SetIcon`
Sets the Icon.
`GetScreenPosition`
Gets the Screen Position.
`Raycast`
Raycasts from 2d to 3d space.
`IsButtonDown`
Detects if button is down.
RayIntersectOBB
Arguments
ox, oy, oz, dx, dy, dz, partReturns
This function returns nothing.
readRayCollision
Arguments
bufReturns
This function returns nothing.
SetIcon
Sets the Icon.
Arguments
mouse: any, icon: anyReturns
booleanGetScreenPosition
Gets the Screen Position.
Arguments
mouse: anyReturns
booleanRaycast
Raycasts from 2d to 3d space.
Arguments
mouse: any, distance: numberReturns
booleanIsButtonDown
Detects if button is down.
Arguments
mouse: any, button: tableReturns
booleanAPI
instance:RayIntersectOBB(ox, oy, oz, dx, dy, dz, part)
instance:readRayCollision(buf)
instance:SetIcon(mouse: any, icon: any): boolean
instance:GetScreenPosition(mouse: any): boolean
instance:Raycast(mouse: any, distance: number): boolean
instance:IsButtonDown(mouse: any, button: table): boolean