Script Classes for Adventure Games/Event Class

From SCI Wiki
Jump to: navigation, search

Official SCI Documentation

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

Author: Jeff Stephenson

Date: 5 April 1988

 


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.
menuStart
menuHit

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
y

The 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


 

Table of Contents

 

< Previous: The Avoider Class Next: The User Class >