moe.maple.api.script.model.BaseScript

All Implemented Interfaces:: MoeScript

Direct Known Subclasses:: CommandScript, FieldScript, NpcScript, PortalScript, ReactorScript

public abstract class BaseScript
extends Object
implements MoeScript

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`expected`
`protected FieldObject<?>`	`field`
`protected FieldSetObject<?>`	`fieldset`
`protected InventorySlotObject<?>`	`item`
`protected ScriptAction`	`nextAction`
`protected ScriptResponse`	`nextResponse`
`protected NpcObject<?>`	`npc`
`protected PortalObject<?>`	`portal`
`protected QuestObject<?>`	`quest`
`protected ReactorObject<?>`	`reactor`
`protected ServerObject<?>`	`server`
`protected UserObject<?>`	`user`

Constructor Summary

Constructors

Constructor Description

BaseScript()

Method Summary

Modifier and Type	Method	Description
`void`	`addAfterRunEvent(ScriptEvent event)`	Called internally after the work method.
`void`	`addBeforeRunEvent(ScriptEvent event)`	Called internally before the work method.
`void`	`addEndEvent(ScriptEvent event)`	Called in `MoeScript.end()`
`void`	`addNoPermissionEvent(ScriptEvent event)`	Called in `MoeScript.start()` if script fails `MoeScript.hasPermission()`
`void`	`addStartEvent(ScriptEvent event)`	Called in `MoeScript.start()`
`void`	`end()`	End the script, calling all events attached.
`void`	`escape()`	Called if `MoeScript.resume(Number, Number, Object)`'s `action` matches the escape event, typically -1.
`String`	`getExpected()`	See `MoeScript.setExpected(String)`
`Optional<FieldObject<?>>`	`getFieldObject()`
`Optional<FieldSetObject<?>>`	`getFieldSetObject()`
`Optional<InventorySlotObject<?>>`	`getInventorySlotObject()`
`Optional<NpcObject<?>>`	`getNpcObject()`
`Optional<PortalObject<?>>`	`getPortalObject()`
`Optional<QuestObject<?>>`	`getQuestObject()`
`Optional<ReactorObject<?>>`	`getReactorObject()`
`Optional<ServerObject<?>>`	`getServerObject()`
`Optional<UserObject<?>>`	`getUserObject()`
`boolean`	`isDone()`	Has the script used `MoeScript.start()` and reached `MoeScript.end()`
`boolean`	`isNextActionSet()`
`boolean`	`isNextResponseSet()`
`boolean`	`isPaused()`	Is the script waiting for a response for `MoeScript.resume(Number, Number, Object)`
`String`	`name()`
`void`	`reset()`	Resets the script back to a default state.
`void`	`resume(Number type, Number action, Object response)`	Resumes the scripts
`void`	`setEscapeEvent(ScriptEvent event)`	Called in `MoeScript.resume(Number, Number, Object)` if a user issues an escape action
`void`	`setExpected(String expected)`	Scripts can have multiple names and aliases, since it is unsure which script you're aiming at, you need to set the expected value here, for clarity.
`void`	`setFieldObject(FieldObject<?> field)`
`void`	`setFieldSetObject(FieldSetObject<?> fieldset)`
`void`	`setInventorySlotObject(InventorySlotObject<?> item)`
`void`	`setNpcObject(NpcObject<?> npc)`
`void`	`setPortalObject(PortalObject<?> portal)`
`void`	`setQuestObject(QuestObject<?> quest)`
`void`	`setReactorObject(ReactorObject<?> reactor)`
`void`	`setScriptAction(ScriptAction action)`
`void`	`setScriptResponse(ScriptResponse response)`
`void`	`setServerObject(ServerObject<?> object)`
`void`	`setUserObject(UserObject<?> user)`
`void`	`start()`	Start the script, calling all events attached.
`protected abstract void`	`work()`

Methods inherited from class java.lang.Object

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

Methods inherited from interface moe.maple.api.script.model.MoeScript

getSpeakerTemplateId, hasPermission, resetAndStart

Field Details
- expected
  
  protected String expected
- nextAction
  
  protected ScriptAction nextAction
- nextResponse
  
  protected ScriptResponse nextResponse
- server
  
  protected ServerObject<?> server
- field
  
  protected FieldObject<?> field
- fieldset
  
  protected FieldSetObject<?> fieldset
- npc
  
  protected NpcObject<?> npc
- portal
  
  protected PortalObject<?> portal
- quest
  
  protected QuestObject<?> quest
- reactor
  
  protected ReactorObject<?> reactor
- item
  
  protected InventorySlotObject<?> item
- user
  
  protected UserObject<?> user
Constructor Details
- BaseScript
  
  public BaseScript()
Method Details
- name
  
  public String name()
  
  Specified by:
  
  name in interface MoeScript
- setExpected
  
  public void setExpected(String expected)
  
  Description copied from interface: MoeScript
  
  Scripts can have multiple names and aliases, since it is unsure which script you're aiming at, you need to set the expected value here, for clarity.
  
  Specified by:
  
  setExpected in interface MoeScript
- getExpected
  
  public String getExpected()
  
  Description copied from interface: MoeScript
  
  See MoeScript.setExpected(String)
  
  Specified by:
  
  getExpected in interface MoeScript
- work
  
  protected abstract void work()
- isDone
  
  public boolean isDone()
  
  Description copied from interface: MoeScript
  
  Has the script used MoeScript.start() and reached MoeScript.end()
  
  Specified by:
  
  isDone in interface MoeScript
- isPaused
  
  public boolean isPaused()
  
  Description copied from interface: MoeScript
  
  Is the script waiting for a response for MoeScript.resume(Number, Number, Object)
  
  Specified by:
  
  isPaused in interface MoeScript
- isNextActionSet
  
  public boolean isNextActionSet()
  
  Specified by:
  
  isNextActionSet in interface MoeScript
- isNextResponseSet
  
  public boolean isNextResponseSet()
  
  Specified by:
  
  isNextResponseSet in interface MoeScript
- start
  
  public void start()
  
  Description copied from interface: MoeScript
  
  Start the script, calling all events attached.
  
  Specified by:
  
  start in interface MoeScript
- end
  
  public void end()
  
  Description copied from interface: MoeScript
  
  End the script, calling all events attached.
  
  Specified by:
  
  end in interface MoeScript
- escape
  
  public void escape()
  
  Description copied from interface: MoeScript
  
  Called if MoeScript.resume(Number, Number, Object)'s action matches the escape event, typically -1. If escape event is null, then MoeScript.end() is called.
  
  Specified by:
  
  escape in interface MoeScript
- reset
  
  public void reset()
  
  Description copied from interface: MoeScript
  
  Resets the script back to a default state.
  
  Specified by:
  
  reset in interface MoeScript
- resume
  
  public void resume(Number type, Number action, Object response)
  
  Description copied from interface: MoeScript
  
  Resumes the scripts
  
  Specified by:
  
  resume in interface MoeScript
  
  Parameters:
  
  type - - ScriptMessageType
  
  action - - The action for the type
  
  response - - The object to respond with
- setScriptAction
  
  public void setScriptAction(ScriptAction action)
  
  Specified by:
  
  setScriptAction in interface MoeScript
- setScriptResponse
  
  public void setScriptResponse(ScriptResponse response)
  
  Specified by:
  
  setScriptResponse in interface MoeScript
- setEscapeEvent
  
  public void setEscapeEvent(ScriptEvent event)
  
  Description copied from interface: MoeScript
  
  Called in MoeScript.resume(Number, Number, Object) if a user issues an escape action
  
  Specified by:
  
  setEscapeEvent in interface MoeScript
- addStartEvent
  
  public void addStartEvent(ScriptEvent event)
  
  Description copied from interface: MoeScript
  
  Called in MoeScript.start()
  
  Specified by:
  
  addStartEvent in interface MoeScript
- addEndEvent
  
  public void addEndEvent(ScriptEvent event)
  
  Description copied from interface: MoeScript
  
  Called in MoeScript.end()
  
  Specified by:
  
  addEndEvent in interface MoeScript
- addAfterRunEvent
  
  public void addAfterRunEvent(ScriptEvent event)
  
  Description copied from interface: MoeScript
  
  Called internally after the work method.
  
  Specified by:
  
  addAfterRunEvent in interface MoeScript
- addBeforeRunEvent
  
  public void addBeforeRunEvent(ScriptEvent event)
  
  Description copied from interface: MoeScript
  
  Called internally before the work method.
  
  Specified by:
  
  addBeforeRunEvent in interface MoeScript
- addNoPermissionEvent
  
  public void addNoPermissionEvent(ScriptEvent event)
  
  Description copied from interface: MoeScript
  
  Called in MoeScript.start() if script fails MoeScript.hasPermission()
  
  Specified by:
  
  addNoPermissionEvent in interface MoeScript
- setServerObject
  
  public void setServerObject(ServerObject<?> object)
  
  Specified by:
  
  setServerObject in interface MoeScript
- setFieldObject
  
  public void setFieldObject(FieldObject<?> field)
  
  Specified by:
  
  setFieldObject in interface MoeScript
- setFieldSetObject
  
  public void setFieldSetObject(FieldSetObject<?> fieldset)
  
  Specified by:
  
  setFieldSetObject in interface MoeScript
- setNpcObject
  
  public void setNpcObject(NpcObject<?> npc)
  
  Specified by:
  
  setNpcObject in interface MoeScript
- setPortalObject
  
  public void setPortalObject(PortalObject<?> portal)
  
  Specified by:
  
  setPortalObject in interface MoeScript
- setQuestObject
  
  public void setQuestObject(QuestObject<?> quest)
  
  Specified by:
  
  setQuestObject in interface MoeScript
- setInventorySlotObject
  
  public void setInventorySlotObject(InventorySlotObject<?> item)
  
  Specified by:
  
  setInventorySlotObject in interface MoeScript
- setReactorObject
  
  public void setReactorObject(ReactorObject<?> reactor)
  
  Specified by:
  
  setReactorObject in interface MoeScript
- setUserObject
  
  public void setUserObject(UserObject<?> user)
  
  Specified by:
  
  setUserObject in interface MoeScript
- getInventorySlotObject
  
  public Optional<InventorySlotObject<?>> getInventorySlotObject()
  
  Specified by:
  
  getInventorySlotObject in interface MoeScript
- getServerObject
  
  public Optional<ServerObject<?>> getServerObject()
  
  Specified by:
  
  getServerObject in interface MoeScript
- getFieldObject
  
  public Optional<FieldObject<?>> getFieldObject()
  
  Specified by:
  
  getFieldObject in interface MoeScript
- getFieldSetObject
  
  public Optional<FieldSetObject<?>> getFieldSetObject()
  
  Specified by:
  
  getFieldSetObject in interface MoeScript
- getNpcObject
  
  public Optional<NpcObject<?>> getNpcObject()
  
  Specified by:
  
  getNpcObject in interface MoeScript
- getPortalObject
  
  public Optional<PortalObject<?>> getPortalObject()
  
  Specified by:
  
  getPortalObject in interface MoeScript
- getQuestObject
  
  public Optional<QuestObject<?>> getQuestObject()
  
  Specified by:
  
  getQuestObject in interface MoeScript
- getReactorObject
  
  public Optional<ReactorObject<?>> getReactorObject()
  
  Specified by:
  
  getReactorObject in interface MoeScript
- getUserObject
  
  public Optional<UserObject<?>> getUserObject()
  
  Specified by:
  
  getUserObject in interface MoeScript

Class BaseScript

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface moe.maple.api.script.model.MoeScript

Field Details

Constructor Details

Method Details