105,964
edits
Changes
Modding:Modder Guide/APIs/Input (view source)
Revision as of 01:06, 8 November 2021
, 01:06, 8 November 2021Text replacement - "i.e. " to "''i.e.,'' "
|-
|-
| <code>IsDown()</code>
| <code>IsDown()</code>
| Get whether any keybind in the list is currently down (i.e. the player pressed or is holding down the keys).
| Get whether any keybind in the list is currently down (''i.e.,'' the player pressed or is holding down the keys).
|-
|-
| <code>JustPressed()</code>
| <code>JustPressed()</code>
| Get whether the player just activated the keybind during the current tick (i.e. <code>GetState()</code> returns <samp>Pressed</samp> instead of <samp>Held</samp>).
| Get whether the player just activated the keybind during the current tick (''i.e.,'' <code>GetState()</code> returns <samp>Pressed</samp> instead of <samp>Held</samp>).
|-
|-
| <code>GetKeybindCurrentlyDown()</code>
| <code>GetKeybindCurrentlyDown()</code>
This is returned by the <samp>this.Helper.Input.GetCursorPosition()</samp> method and in the event args for some input events.
This is returned by the <samp>this.Helper.Input.GetCursorPosition()</samp> method and in the event args for some input events.
'''The pixel positions are ''not'' adjusted for [[Modding:Modder Guide/Game Fundamentals#UI scaling|UI scaling]]''' (i.e. they're non-UI mode). Whether you need UI or non-UI positions depends how you're using them, so you can use <samp>cursorPos.GetScaledAbsolutePixels()</samp> or <samp>cursorPos.GetScaledScreenPixels()</samp> to adjust them automatically for the current mode or <samp>Utility.ModifyCoordinatesForUIScale</samp> to always get UI mode coordinates.
'''The pixel positions are ''not'' adjusted for [[Modding:Modder Guide/Game Fundamentals#UI scaling|UI scaling]]''' (''i.e.,'' they're non-UI mode). Whether you need UI or non-UI positions depends how you're using them, so you can use <samp>cursorPos.GetScaledAbsolutePixels()</samp> or <samp>cursorPos.GetScaledScreenPixels()</samp> to adjust them automatically for the current mode or <samp>Utility.ModifyCoordinatesForUIScale</samp> to always get UI mode coordinates.
==See also==
==See also==
* [[../Events#Input|Input events]]
* [[../Events#Input|Input events]]
* [[Modding:Player Guide/Key Bindings]] for a list of valid <samp>SButton</samp> values
* [[Modding:Player Guide/Key Bindings]] for a list of valid <samp>SButton</samp> values