Skip to content

Document InputObject behavior in CAS action functions #1110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 21, 2025
Merged

Document InputObject behavior in CAS action functions #1110

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5dbca9c
Document InputObject behavior in CAS action functions
EmeraldSlash May 21, 2025
50a626f
Apply suggestions from code review
IgnisRBX May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions content/en-us/reference/engine/classes/ContextActionService.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,25 +149,26 @@ methods:
<tr>
<td>1</td>
<td><code>string</code></td>
<td>The same string that was originally passed to BindAction†</td>
<td>The same string that was originally passed to <code>Class.ContextActionService:BindAction()|BindAction()</code>.
This allows one function to handle multiple actions at once, if necessary.</td>
</tr>
<tr>
<td>2</td>
<td><code>Enum.UserInputState</code></td>
<td>The state of the input (Begin, Change, End or Cancel)*</td>
<td>The state of the input. <code>Enum.UserInputState|Cancel</code> is sent
if some input was in progress and another action bound over that in-progress
input, or if the in-progress bound action was unbound through <code>Class.ContextActionService:UnbindAction()|UnbindAction()</code>.</td>
</tr>
<tr>
<td>3</td>
<td><code>InputObject</code></td>
<td>An object that contains information about the input (varies based on UserInputType)</td>
<td>An object that contains information about the input (varies based on
<code>Enum.UserInputType</code>). The <code>Class.InputObject</code> sometimes won't match the inputs the action
was bound to: when the <code>Enum.UserInputState|Cancel</code> state is sent, this object will be
<code>Enum.KeyCode.Unknown</code> and <code>Enum.UserInputType.None</code>.</td>
</tr>
</table>

† This allows one function to handle multiple actions at once, if
necessary. \*Cancel is sent if some input was in-progress and another
action bound over the in-progress input, or if the in-progress bound
action was `Class.ContextActionService:UnbindAction()|unbound`.

#### Action Bindings Stack

Action bindings behave like a stack: if two actions are bound to the same
Expand Down