Skip to content

Commit 681e511

Browse files
committed
Bring in ScreenSpaceEventHandler type fixes
from #9275
1 parent 1901113 commit 681e511

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

Source/Core/ScreenSpaceEventHandler.js

+7-6
Original file line numberDiff line numberDiff line change
@@ -934,12 +934,13 @@ function ScreenSpaceEventHandler(element) {
934934
registerListeners(this);
935935
}
936936

937+
// TODO: document callback signature for each type of event
937938
/**
938939
* Set a function to be executed on an input event.
939940
*
940941
* @param {Function} action Function to be executed when the input event occurs.
941-
* @param {Number} type The ScreenSpaceEventType of input event.
942-
* @param {Number} [modifier] A KeyboardEventModifier key that is held when a <code>type</code>
942+
* @param {ScreenSpaceEventType} type The ScreenSpaceEventType of input event.
943+
* @param {KeyboardEventModifier} [modifier] A KeyboardEventModifier key that is held when a <code>type</code>
943944
* event occurs.
944945
*
945946
* @see ScreenSpaceEventHandler#getInputAction
@@ -966,8 +967,8 @@ ScreenSpaceEventHandler.prototype.setInputAction = function (
966967
/**
967968
* Returns the function to be executed on an input event.
968969
*
969-
* @param {Number} type The ScreenSpaceEventType of input event.
970-
* @param {Number} [modifier] A KeyboardEventModifier key that is held when a <code>type</code>
970+
* @param {ScreenSpaceEventType} type The ScreenSpaceEventType of input event.
971+
* @param {KeyboardEventModifier} [modifier] A KeyboardEventModifier key that is held when a <code>type</code>
971972
* event occurs.
972973
*
973974
* @returns {Function} The function to be executed on an input event.
@@ -989,8 +990,8 @@ ScreenSpaceEventHandler.prototype.getInputAction = function (type, modifier) {
989990
/**
990991
* Removes the function to be executed on an input event.
991992
*
992-
* @param {Number} type The ScreenSpaceEventType of input event.
993-
* @param {Number} [modifier] A KeyboardEventModifier key that is held when a <code>type</code>
993+
* @param {ScreenSpaceEventType} type The ScreenSpaceEventType of input event.
994+
* @param {KeyboardEventModifier} [modifier] A KeyboardEventModifier key that is held when a <code>type</code>
994995
* event occurs.
995996
*
996997
* @see ScreenSpaceEventHandler#getInputAction

0 commit comments

Comments
 (0)