cleoni.adv
Class Event

java.lang.Object
  cleoni.adv.ManageableObject
      cleoni.adv.Event

public class Event
extends ManageableObject

Represents an EVENT, a FUNCTION or a SUB. Contains the associated script code.

Field Summary

int	actionsStartLine
java.lang.String	attachedEventsId
java.lang.String	fileName
java.lang.String	fileShort
java.lang.String	id
static java.lang.String	onCloseEvent onClose
static java.lang.String	onConsoleCommandEvent _ConsoleCommand
static java.lang.String	onDbUpEvent onDbUp
static java.lang.String	onDieEvent onDia
static java.lang.String	onDroppedEvent whenDropped
static java.lang.String	onEnterEvent onEnter
static java.lang.String	onExitEvent onExit
static java.lang.String	onGiveEvent onGive
static java.lang.String	onHearEvent onHear
static java.lang.String	onHideEvent onHide
static java.lang.String	onLivingEvent Living
static java.lang.String	onLockEvent lock
static java.lang.String	onLookEvent onLook
static java.lang.String	onLooseEvent onLoose
static java.lang.String	onLooseItemEvent onLooseItem
static java.lang.String	onNewEvent onNew
static java.lang.String	onOpenEvent onOpen
static java.lang.String	onPickedEvent whenPicked
static java.lang.String	onReceiveEvent onReceive
static java.lang.String	onReceiveItemEvent onReceiveItem
static java.lang.String	onRestoreEvent restore
static java.lang.String	onSaveEvent onSave
static java.lang.String	onSaveInfoEvent saveInfo
static java.lang.String	onSearchEvent onSearch
static java.lang.String	onSpeechFinishEvent onSpeechFinish
static java.lang.String	onStartEvent onStart
static java.lang.String	onTickEvent onTick
static java.lang.String	onUnlockEvent unlock
static java.lang.String	onUseEvent onUse
static java.lang.String	onUseWithEvent onUseWith
DimxObject	owner
java.lang.String	type

Fields inherited from class cleoni.adv.ManageableObject

methodArgs, methods

Constructor Summary

Event(DimxObject aParent, java.lang.String anId, DimxObject anOwner, java.lang.String aType, java.util.Vector vParams)
Event constructor comment.

Method Summary

Token	executeActions(DimxObject owner, java.lang.String agent, java.lang.String target, Token defaultResult)
Token	fire_t(DimxObject owner, java.lang.String agent, java.lang.String target, DictSorted params, Token defaultResult) Fires an event - first searching for object-specific, the searching for generic.
boolean	fire(DimxObject owner, java.lang.String agent, java.lang.String target, DictSorted input, boolean defaultResult)
java.lang.String	getActions()
java.util.Vector	getFormalParams()
java.lang.String	getId()
int	getNoFormalParams()
void	setActions(java.lang.String actionsBlock, int startLine, java.lang.String aFileName)
java.lang.String	toString()

Methods inherited from class cleoni.adv.ManageableObject

execMethod, getMethodArgs, getMethods, getName, hasMethod, varExists, varGet, varGet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

onCloseEvent

public static final java.lang.String onCloseEvent

onClose

See Also:

Constant Field Values

onConsoleCommandEvent

public static final java.lang.String onConsoleCommandEvent

_ConsoleCommand

See Also:

Constant Field Values

onDbUpEvent

public static final java.lang.String onDbUpEvent

onDbUp

See Also:

Constant Field Values

onDieEvent

public static final java.lang.String onDieEvent

onDia

See Also:

Constant Field Values

onDroppedEvent

public static final java.lang.String onDroppedEvent

whenDropped

See Also:

Constant Field Values

onEnterEvent

public static final java.lang.String onEnterEvent

onEnter

See Also:

Constant Field Values

onExitEvent

public static final java.lang.String onExitEvent

onExit

See Also:

Constant Field Values

onGiveEvent

public static final java.lang.String onGiveEvent

onGive

See Also:

Constant Field Values

onHearEvent

public static final java.lang.String onHearEvent

onHear

See Also:

Constant Field Values

onHideEvent

public static final java.lang.String onHideEvent

onHide

See Also:

Constant Field Values

onLivingEvent

public static final java.lang.String onLivingEvent

Living

See Also:

Constant Field Values

onLockEvent

public static final java.lang.String onLockEvent

lock

See Also:

Constant Field Values

onLookEvent

public static final java.lang.String onLookEvent

onLook

See Also:

Constant Field Values

onLooseEvent

public static final java.lang.String onLooseEvent

onLoose

See Also:

Constant Field Values

onLooseItemEvent

public static final java.lang.String onLooseItemEvent

onLooseItem

See Also:

Constant Field Values

onNewEvent

public static final java.lang.String onNewEvent

onNew

See Also:

Constant Field Values

onOpenEvent

public static final java.lang.String onOpenEvent

onOpen

See Also:

Constant Field Values

onPickedEvent

public static final java.lang.String onPickedEvent

whenPicked

See Also:

Constant Field Values

onReceiveEvent

public static final java.lang.String onReceiveEvent

onReceive

See Also:

Constant Field Values

onReceiveItemEvent

public static final java.lang.String onReceiveItemEvent

onReceiveItem

See Also:

Constant Field Values

onRestoreEvent

public static final java.lang.String onRestoreEvent

restore

See Also:

Constant Field Values

onSaveEvent

public static final java.lang.String onSaveEvent

onSave

See Also:

Constant Field Values

onSaveInfoEvent

public static final java.lang.String onSaveInfoEvent

saveInfo

See Also:

Constant Field Values

onSearchEvent

public static final java.lang.String onSearchEvent

onSearch

See Also:

Constant Field Values

onSpeechFinishEvent

public static final java.lang.String onSpeechFinishEvent

onSpeechFinish

See Also:

Constant Field Values

onStartEvent

public static final java.lang.String onStartEvent

onStart

See Also:

Constant Field Values

onTickEvent

public static final java.lang.String onTickEvent

onTick

See Also:

Constant Field Values

onUseEvent

public static final java.lang.String onUseEvent

onUse

See Also:

Constant Field Values

onUnlockEvent

public static final java.lang.String onUnlockEvent

unlock

See Also:

Constant Field Values

onUseWithEvent

public static final java.lang.String onUseWithEvent

onUseWith

See Also:

Constant Field Values

id

public java.lang.String id

type

public java.lang.String type

attachedEventsId

public java.lang.String attachedEventsId

actionsStartLine

public int actionsStartLine

fileName

public java.lang.String fileName

fileShort

public java.lang.String fileShort

owner

public DimxObject owner

Constructor Detail

Event

public Event(DimxObject aParent,
             java.lang.String anId,
             DimxObject anOwner,
             java.lang.String aType,
             java.util.Vector vParams)
      throws DimxException

Event constructor comment.

Throws:

DimxException

Method Detail

fire_t

public Token fire_t(DimxObject owner,
                    java.lang.String agent,
                    java.lang.String target,
                    DictSorted params,
                    Token defaultResult)
             throws DimxException

Fires an event - first searching for object-specific, the searching for generic. This version returns a Token result NOTE - This function is almost equal to fire() - please keep them aligned or merge them

Parameters:

owner -

agent -

target -

params - Must be a DictSorted of values to be passed to the event as parameters. Could contain also the "input" parameter which in turn must be a DictSorted.

defaultResult -

Returns:

Token result

Throws:

DimxException

fire

public boolean fire(DimxObject owner,
                    java.lang.String agent,
                    java.lang.String target,
                    DictSorted input,
                    boolean defaultResult)
             throws DimxException

Throws:

DimxException

toString

public java.lang.String toString()

Overrides:

toString in class ManageableObject

executeActions

public Token executeActions(DimxObject owner,
                            java.lang.String agent,
                            java.lang.String target,
                            Token defaultResult)
                     throws DimxException

Throws:

DimxException

getActions

public java.lang.String getActions()

getId

public java.lang.String getId()

Overrides:

getId in class ManageableObject

getNoFormalParams

public int getNoFormalParams()

getFormalParams

public java.util.Vector getFormalParams()

setActions

public void setActions(java.lang.String actionsBlock,
                       int startLine,
                       java.lang.String aFileName)