Difference between revisions of "Script Classes for Adventure Games/Event Class"
| (5 intermediate revisions by the same user not shown) | |||
| Line 54: | Line 54: | ||
<blockquote> | <blockquote> | ||
| − | ==== | + | ==== type ==== |
<blockquote>The kind of input event. The event types are defined in kernel.sh: | <blockquote>The kind of input event. The event types are defined in kernel.sh: | ||
| − | ===== | + | ===== mouseDown ===== |
<blockquote>Mouse button was pressed.</blockquote> | <blockquote>Mouse button was pressed.</blockquote> | ||
| − | ===== | + | ===== mouseUp ===== |
<blockquote>Mouse button was released.</blockquote> | <blockquote>Mouse button was released.</blockquote> | ||
| − | ===== | + | ===== keyDown ===== |
<blockquote>Key was pressed.</blockquote> | <blockquote>Key was pressed.</blockquote> | ||
| − | ===== | + | ===== keyUp ===== |
<blockquote>Key was released.</blockquote> | <blockquote>Key was released.</blockquote> | ||
| − | ===== | + | ===== direction ===== |
<blockquote>A direction event, meant to move the player.</blockquote> | <blockquote>A direction event, meant to move the player.</blockquote> | ||
| − | ===== | + | ===== saidEvent ===== |
<blockquote>User typed a line of input, which has been parsed.</blockquote> | <blockquote>User typed a line of input, which has been parsed.</blockquote> | ||
| − | ===== | + | ===== menuStart ===== |
| − | ===== | + | ===== menuHit ===== |
</blockquote> | </blockquote> | ||
| − | ==== | + | ==== message ==== |
<blockquote>The 'value' of the event. For a key, this is the ASCII value corresponding to the key which was pressed.</blockquote> | <blockquote>The 'value' of the event. For a key, this is the ASCII value corresponding to the key which was pressed.</blockquote> | ||
| − | ==== | + | ==== modifiers ==== |
<blockquote>Bit-mapped property containing any modifier keys which were down when the event occurred. Bits are shiftDown, ctrlDown, and altDown.</blockquote> | <blockquote>Bit-mapped property containing any modifier keys which were down when the event occurred. Bits are shiftDown, ctrlDown, and altDown.</blockquote> | ||
| − | ==== | + | ==== x <br /> y ==== |
<blockquote>The coordinates of the mouse when the event occurred.</blockquote> | <blockquote>The coordinates of the mouse when the event occurred.</blockquote> | ||
| − | ==== | + | ==== claimed ==== |
<blockquote>TRUE if some object has already responded to the event, FALSE otherwise. You should set the claimed property of the event to TRUE whenever you respond to an event. In general, you will not want to respond to an event whose claimed property is TRUE (although there may be exceptions), so you'll want to test its value before doing anything based on the event.</blockquote> | <blockquote>TRUE if some object has already responded to the event, FALSE otherwise. You should set the claimed property of the event to TRUE whenever you respond to an event. In general, you will not want to respond to an event whose claimed property is TRUE (although there may be exceptions), so you'll want to test its value before doing anything based on the event.</blockquote> | ||
</blockquote> | </blockquote> | ||
| Line 88: | Line 88: | ||
<blockquote> | <blockquote> | ||
| − | ==== | + | ==== new: ==== |
<blockquote>If an input event is in the event queue, return it. Otherwise, return 0.</blockquote> | <blockquote>If an input event is in the event queue, return it. Otherwise, return 0.</blockquote> | ||
</blockquote> | </blockquote> | ||
Latest revision as of 00:59, 11 December 2015
Chapter:
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
Index
The Event Class
The Event class is the class of user input events (key presses, mouse clicks, etc.)
| In file: | system.sc |
| Inherits from: | Object |
| Inherited by: | none |
Properties
type
The kind of input event. The event types are defined in kernel.sh:
mouseDown
Mouse button was pressed.
mouseUp
Mouse button was released.
keyDown
Key was pressed.
keyUp
Key was released.
direction
A direction event, meant to move the player.
saidEvent
User typed a line of input, which has been parsed.
message
The 'value' of the event. For a key, this is the ASCII value corresponding to the key which was pressed.
modifiers
Bit-mapped property containing any modifier keys which were down when the event occurred. Bits are shiftDown, ctrlDown, and altDown.
x
yThe coordinates of the mouse when the event occurred.
claimed
TRUE if some object has already responded to the event, FALSE otherwise. You should set the claimed property of the event to TRUE whenever you respond to an event. In general, you will not want to respond to an event whose claimed property is TRUE (although there may be exceptions), so you'll want to test its value before doing anything based on the event.
Methods
new:
If an input event is in the event queue, return it. Otherwise, return 0.
- Notes
< Previous: The Avoider Class Next: The User Class >
