langband-engine Reference Documentation

Previous: MESSAGE Up: Package ORG.LANGBAND.ENGINE Next: MESSAGE-HANDLER-FLOW

MESSAGE-HANDLER

Name

MESSAGE-HANDLER -- class

Description

This is an 'abstract' class for handling game-messages that should be presented to the user. How these are presented may differ from player to player so it's put in a class for further tweaking by variants. The langband engine provides two working subclasses, a -more- based one, and one message handler that lets messages flow freely. Adding a filter should also be doable.

Class details

(defclass MESSAGE-HANDLER ()(...))
scopepackage ORG.LANGBAND.ENGINE
locationclasses.lisp
# variables6
# methods12

Methods

(SETF MSGHANDLER.CUR-MAX-COL) 
 ((SETF MSGHANDLER.CUR-MAX-COL) (OBJ MESSAGE-HANDLER)) [accessor]
Description 

What is the maximum coloumn in the message-frame.

Called By 

INIT-MESSAGE-SYSTEM&

MSGHANDLER.CUR-MAX-COL 
 (MSGHANDLER.CUR-MAX-COL (OBJ MESSAGE-HANDLER)) [accessor]
Description 

What is the maximum coloumn in the message-frame.

Called By 

TRY-PRINTING-MESSAGES! and TRY-PRINTING-MESSAGES!

(SETF MSGHANDLER.CUR-MSG-COL) 
 ((SETF MSGHANDLER.CUR-MSG-COL) (OBJ MESSAGE-HANDLER)) [accessor]
Description 

At what column in the message-frame is the message-printer.

Called By 

TRY-PRINTING-MESSAGES! and TRY-PRINTING-MESSAGES!

MSGHANDLER.CUR-MSG-COL 
 (MSGHANDLER.CUR-MSG-COL (OBJ MESSAGE-HANDLER)) [accessor]
Description 

At what column in the message-frame is the message-printer.

Called By 

TRY-PRINTING-MESSAGES! and TRY-PRINTING-MESSAGES!

(SETF MSGHANDLER.CUR-MSG-ROW) 
 ((SETF MSGHANDLER.CUR-MSG-ROW) (OBJ MESSAGE-HANDLER)) [accessor]
Description 

At what row in the message-frame is the message-printer.

Called By 

ADVANCE-MESSAGE-SYS! and ADVANCE-MESSAGE-SYS!

MSGHANDLER.CUR-MSG-ROW 
 (MSGHANDLER.CUR-MSG-ROW (OBJ MESSAGE-HANDLER)) [accessor]
Description 

At what row in the message-frame is the message-printer.

Called By 

ADVANCE-MESSAGE-SYS!, ADVANCE-MESSAGE-SYS!, TRY-PRINTING-MESSAGES! and TRY-PRINTING-MESSAGES!

(SETF MSGHANDLER.INCOMING-MSGS) 
 ((SETF MSGHANDLER.INCOMING-MSGS) (OBJ MESSAGE-HANDLER)) [accessor]
Description 

A list of incoming messages that must be displayed.

Called By 

PRINT-MESSAGE!

MSGHANDLER.INCOMING-MSGS 
 (MSGHANDLER.INCOMING-MSGS (OBJ MESSAGE-HANDLER)) [accessor]
Description 

A list of incoming messages that must be displayed.

Called By 

PRINT-MESSAGE!, TRY-PRINTING-MESSAGES! and TRY-PRINTING-MESSAGES!

(SETF MSGHANDLER.SHOWN-MSGS) 
 ((SETF MSGHANDLER.SHOWN-MSGS) (OBJ MESSAGE-HANDLER)) [accessor]
Description 

A list of messages already shown.

MSGHANDLER.SHOWN-MSGS 
 (MSGHANDLER.SHOWN-MSGS (OBJ MESSAGE-HANDLER)) [accessor]
Description 

A list of messages already shown.

Called By 

GET-MESSAGES, TRY-PRINTING-MESSAGES! and TRY-PRINTING-MESSAGES!

(SETF MSGHANDLER.STATE) 
 ((SETF MSGHANDLER.STATE) (OBJ MESSAGE-HANDLER)) [accessor]
Description 

State of the message-system.

Called By 

ADVANCE-MESSAGE-SYS!, ADVANCE-MESSAGE-SYS! and TRY-PRINTING-MESSAGES!

MSGHANDLER.STATE 
 (MSGHANDLER.STATE (OBJ MESSAGE-HANDLER)) [accessor]
Description 

State of the message-system.

Called By 

GET-AND-PROCESS-COMMAND!, TRY-PRINTING-MESSAGES! and TRY-PRINTING-MESSAGES!

Slots

CUR-MAX-COL 
slot CUR-MAX-COL is of type T
Description 

What is the maximum coloumn in the message-frame.

CUR-MSG-COL 
slot CUR-MSG-COL is of type T
Description 

At what column in the message-frame is the message-printer.

CUR-MSG-ROW 
slot CUR-MSG-ROW is of type T
Description 

At what row in the message-frame is the message-printer.

INCOMING-MSGS 
slot INCOMING-MSGS is of type T
Description 

A list of incoming messages that must be displayed.

SHOWN-MSGS 
slot SHOWN-MSGS is of type T
Description 

A list of messages already shown.

STATE 
slot STATE is of type T
Description 

State of the message-system.

Previous: MESSAGE Up: Package ORG.LANGBAND.ENGINE Next: MESSAGE-HANDLER-FLOW

langband-engine Reference Documentation

This documentation was generated Autumn 2003 from the original sources by Albert v.0.4.9.