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 |
TargetSurface | any | nil |
IsMouseHidden | boolean | false |
IsMouseOutOfBounds | boolean | false |
X | number | 0 |
Y | number | 0 |
ViewSizeX | number | 0 |
ViewSizeY | number | 0 |
Name | string | "Mouse" |
Functions
`getViewport`
`getCamera`
`makeUnitRay`
`appendTargetFilter`
`makeRaycastParams`
`castMouseRay`
`updateMouse`
`SetIcon`
Sets the Icon.
`GetScreenPosition`
Gets the Screen Position.
`Raycast`
Raycasts from 2d to 3d space.
`IsButtonDown`
Detects if button is down.
getViewport
Arguments
rendererReturns
This function returns nothing.
getCamera
Arguments
workspace, rendererReturns
This function returns nothing.
makeUnitRay
Arguments
camera, mouseX, mouseY, viewportX, viewportY, viewportWidth, viewportHeightReturns
This function returns nothing.
appendTargetFilter
Arguments
params, targetFilterReturns
This function returns nothing.
makeRaycastParams
Arguments
targetFilterReturns
This function returns nothing.
castMouseRay
Arguments
mouse, distanceReturns
This function returns nothing.
updateMouse
Arguments
This function takes no arguments.
Returns
This function returns nothing.
SetIcon
Sets the Icon.
Arguments
mouse, iconReturns
This function returns nothing.
GetScreenPosition
Gets the Screen Position.
Arguments
mouseReturns
This function returns nothing.
Raycast
Raycasts from 2d to 3d space.
Arguments
mouse, distanceReturns
This function returns nothing.
IsButtonDown
Detects if button is down.
Arguments
mouse, buttonReturns
This function returns nothing.
API
instance:getViewport(renderer)
instance:getCamera(workspace, renderer)
instance:makeUnitRay(camera, mouseX, mouseY, viewportX, viewportY, viewportWidth, viewportHeight)
instance:appendTargetFilter(params, targetFilter)
instance:makeRaycastParams(targetFilter)
instance:castMouseRay(mouse, distance)
instance:updateMouse()
instance:SetIcon(mouse, icon)
instance:GetScreenPosition(mouse)
instance:Raycast(mouse, distance)
instance:IsButtonDown(mouse, button)