com.planet_ink.coffee_mud.Common.interfaces
Class ScriptingEngine.ScriptableResponse

java.lang.Object
  com.planet_ink.coffee_mud.Common.interfaces.ScriptingEngine.ScriptableResponse

Enclosing interface:

ScriptingEngine

public static class ScriptingEngine.ScriptableResponse
extends java.lang.Object

An object that holds the information about an event until it is time to execute its associated script.

Field Summary

PhysicalAgent	h (host) the object being scripted
MOB	m (host mob) a mob representation of the host (h)
java.lang.String	message a string associated with this event
Item	pi (primary item) an item associated with this event
MOB	s (source) the source of the event
DVector	scr (script) the actual script to execute for this event
Item	si (second item) a second item associated with this event
Environmental	t (target) the target of the event

Constructor Summary

ScriptingEngine.ScriptableResponse(PhysicalAgent host, MOB source, Environmental target, MOB monster, Item primaryItem, Item secondaryItem, DVector script, int ticks, java.lang.String msg)
Create an event response object

Method Summary

boolean

checkTimeToExecute() Decrements the internal tick counter and returns true if the tick counter has dropped to or below 0

Methods inherited from class java.lang.Object

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

Field Detail

h

public PhysicalAgent h

(host) the object being scripted

s

public MOB s

(source) the source of the event

t

public Environmental t

(target) the target of the event

m

public MOB m

(host mob) a mob representation of the host (h)

pi

public Item pi

(primary item) an item associated with this event

si

public Item si

(second item) a second item associated with this event

scr

public DVector scr

(script) the actual script to execute for this event

message

public java.lang.String message

a string associated with this event

Constructor Detail

ScriptingEngine.ScriptableResponse

public ScriptingEngine.ScriptableResponse(PhysicalAgent host,
                                          MOB source,
                                          Environmental target,
                                          MOB monster,
                                          Item primaryItem,
                                          Item secondaryItem,
                                          DVector script,
                                          int ticks,
                                          java.lang.String msg)

Create an event response object

Parameters:

host - the object being scripted

source - the source of the event

target - the target of the event

monster - a mob representation of the host

primaryItem - an item associated with this event

secondaryItem - a second item associated with this event

script - the actual script to execute for this event

ticks - how many ticks to wait before executing the script

msg - a string associated with this event

Method Detail

checkTimeToExecute

public boolean checkTimeToExecute()

Decrements the internal tick counter and returns true if the tick counter has dropped to or below 0

Returns:

true if its time to execute