yakscript
Interface DisplayInterface

All Known Implementing Classes:

Yakkey

public interface DisplayInterface

Interface implemented by all YakScript displays, used by the interpreter for display-related callbacks

Method Summary

void	blank(boolean state, java.lang.String msg) Callback invoked to (un)blank display
boolean	pause(java.lang.String msg, boolean add) Callback invoked for pausing or user confirmation
void	refresh(boolean isNewFrame) Callback to force display update (after a trigger, etc)
void	reset() Callback invoked to reset display entirely

Method Detail

refresh

public void refresh(boolean isNewFrame)

Callback to force display update (after a trigger, etc)

Returns:

true if frame has changed and complete redraw is needed, false if refetching text labels is enough

blank

public void blank(boolean state,
                  java.lang.String msg)

Callback invoked to (un)blank display

Parameters:

state - true to blank, false to unblank

msg - Message to user

pause

public boolean pause(java.lang.String msg,
                     boolean add)

Callback invoked for pausing or user confirmation

Parameters:

msg - Message to user

add - true to add to old message, false to overwrite

Returns:

True to proceed, false to backtrack

reset

public void reset()

Callback invoked to reset display entirely