# SceneScript Cursor Events
SceneScript offers multiple cursor event that allows you to interact with mouse movements and mouse clicks. The parameter for all cursor events is an CursorEvent object with additional event data.
All mouse cursor events will only work on objects marked as Solid in the layer settings.
# cursorEnter
This event function will be called when the cursor enters the bounds of the object.
export function cursorEnter(event: CursorEvent) {
}
# cursorLeave
This event function will be called when the cursor leaves the bounds of the object.
export function cursorLeave(event: CursorEvent) {
}
# cursorMove
This event function will be called when the cursor has been moved.
export function cursorMove(event: CursorEvent) {
}
# cursorDown
This event function will be called when the cursor is being pressed down on an object.
export function cursorDown(event: CursorEvent) {
}
# cursorUp
This event function will be called when the cursor is being released over an object.
export function cursorUp(event: CursorEvent) {
}
# cursorClick
This event function will be called when the cursor has been pressed and released on the same object. The event is triggered after the cursorUp
and cursorDown
event have been executed.
export function cursorClick(event: CursorEvent) {
}