translators
8,441
edits
Changes
Jump to navigation
Jump to search
Line 264:
Line 264: − <table class="wikitable">+ − <tr>+ − <th>event</th>+ − <th>summary</th>+ − </tr>+ − <tr>+ − <td>ButtonPressed<br />ButtonReleased</td>+ − <td>Raised after the player pressed/released a keyboard, mouse, or controller button. This includes mouse clicks. − Event arguments:+ − * <tt>e.Button</tt>: the button pressed or released, as [[Modding:Modder Guide/APIs/Input#SButton|an <tt>SButton</tt> constant]].+ − * <tt>e.Cursor</tt>: the [[Modding:Modder Guide/APIs/Input#Check cursor position|cursor position and grab tile]].+ − * <tt>e.IsDown</tt>: a method which indicates whether a given button is currently pressed.+ − * <tt>e.IsSuppressed</tt>: a method which indicates whether a given button was suppressed by a mod, so the game itself won't see it.+ + + + + + + + + + + − + − <tr>+ − + − <td>Raised after the player moves the in-game cursor.+ + + + + + + + + + + + + + + + + − Event arguments:+ − * <tt>e.OldPosition</tt>: the previous [[Modding:Modder Guide/APIs/Input#Check cursor position|cursor position and grab tile]].+ − * <tt>e.NewPosition</tt>: the current [[Modding:Modder Guide/APIs/Input#Check cursor position|cursor position and grab tile]].+ − </td> − </tr> − <tr> − <td>MouseWheelScrolled</td> − <td>Raised after the player scrolls the mouse wheel. − Event arguments:+ − * <tt>e.Position</tt>: the current [[Modding:Modder Guide/APIs/Input#Check cursor position|cursor position and grab tile]].+ − * <tt>e.Delta</tt>: the amount by which the mouse wheel was scrolled since the last update.+ − * <tt>e.OldValue</tt> and <tt>e.NewValue</tt>: the previous and current scroll value, cumulative since the game started. Mods should generally use <tt>e.Delta</tt> instead.+ − </td>+ − </tr> − </table>
Modding:Modder Guide/APIs/Events (view source)
Revision as of 23:18, 10 June 2018
, 23:18, 10 June 2018→Events (SMAPI 3.0): use layout template
<tt>this.Helper.Events.Input</tt> has events raised when the player uses a controller, keyboard, or mouse in some way. Can be used with the [[../Input|input API]] to access more info or suppress input.
<tt>this.Helper.Events.Input</tt> has events raised when the player uses a controller, keyboard, or mouse in some way. Can be used with the [[../Input|input API]] to access more info or suppress input.
{| class="wikitable"
|-
! event
! summary
{{/event
|name = ButtonPressed<br />ButtonReleased
|desc = Raised after the player pressed/released a keyboard, mouse, or controller button. This includes mouse clicks.
|arg name 1 = <tt>e.Button</tt>
|arg type 1 = [[Modding:Modder Guide/APIs/Input#SButton|<tt>SButton</tt>]]
|arg desc 1 = The button pressed or released.
|arg name 2 = <tt>e.Cursor</tt>
|arg type 2 = [[Modding:Modder Guide/APIs/Input#Check cursor position|<tt>ICursorPosition</tt>]]
|arg desc 2 = The cursor position and grab tile.
|arg name 3 = <tt>e.IsDown</tt>
|arg type 3 = ''method'' returns <tt>bool</tt>
|arg desc 3 = Indicates whether a given button is currently pressed.
|arg name 4 = <tt>e.IsSuppressed</tt>
|arg type 4 = ''method'' returns <tt>bool</tt>
|arg desc 4 = A method which indicates whether a given button was suppressed by a mod, so the game itself won't see it.
'''Note:''' mods won't receive input sent to the chatbox.
'''Note:''' mods won't receive input sent to the chatbox.
</tr>
}}
{{/event
<td>CursorMoved</td>
|name = CursorMoved
|desc = Raised after the player moves the in-game cursor.
|arg name 1 = <tt>e.OldPosition</tt>
|arg type 1 = [[Modding:Modder Guide/APIs/Input#Check cursor position|ICursorPosition]]
|arg desc 1 = The previous cursor position and grab tile.
|arg name 2 = <tt>e.NewPosition</tt>
|arg type 2 = [[Modding:Modder Guide/APIs/Input#Check cursor position|ICursorPosition]]
|arg desc 2 = The current cursor position and grab tile.
}}
{{/event
|name = MouseWheelScrolled
|desc = Raised after the player scrolls the mouse wheel.
|arg name 1 = <tt>e.Position</tt>
|arg type 1 = [[Modding:Modder Guide/APIs/Input#Check cursor position|ICursorPosition]]
|arg desc 1 = The current cursor position and grab tile.
|arg name 2 = <tt>e.Delta</tt>
|arg type 2 = <tt>int</tt>
|arg desc 2 = The amount by which the mouse wheel was scrolled since the last update.
|arg name 3 = <tt>e.OldValue</tt><br /><tt>e.NewValue</tt>
|arg type 3 = <tt>int</tt>
|arg desc 3 = The previous and current scroll value, cumulative since the game started. Mods should generally use <tt>e.Delta</tt> instead.
}}
|}
{{modding guide footer
{{modding guide footer