All Known Subinterfaces:: LocalEffectScript, MessagingScript, SpeakingScript

All Known Implementing Classes:: BaseScript, CommandScript, FieldScript, ItemScript, MoeNotFound, NpcScript, PortalScript, QuestScript, ReactorScript

public interface MoeScript

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 `end()`
`void`	`addNoPermissionEvent(ScriptEvent event)`	Called in `start()` if script fails `hasPermission()`
`void`	`addStartEvent(ScriptEvent event)`	Called in `start()`
`void`	`end()`	End the script, calling all events attached.
`void`	`escape()`	Called if `resume(Number, Number, Object)`'s `action` matches the escape event, typically -1.
`String`	`getExpected()`	See `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()`
`default int`	`getSpeakerTemplateId()`	Mainly used for packets.
`Optional<UserObject<?>>`	`getUserObject()`
`default boolean`	`hasPermission()`	A check if this script has permission to run.
`boolean`	`isDone()`	Has the script used `start()` and reached `end()`
`boolean`	`isNextActionSet()`
`boolean`	`isNextResponseSet()`
`boolean`	`isPaused()`	Is the script waiting for a response for `resume(Number, Number, Object)`
`String`	`name()`
`void`	`reset()`	Resets the script back to a default state.
`default void`	`resetAndStart()`
`void`	`resume(Number type, Number action, Object response)`	Resumes the scripts
`void`	`setEscapeEvent(ScriptEvent event)`	Called in `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<?> object)`
`void`	`setFieldSetObject(FieldSetObject<?> object)`
`void`	`setInventorySlotObject(InventorySlotObject<?> itemSlot)`
`void`	`setNpcObject(NpcObject<?> object)`
`void`	`setPortalObject(PortalObject<?> object)`
`void`	`setQuestObject(QuestObject<?> object)`
`void`	`setReactorObject(ReactorObject<?> object)`
`void`	`setScriptAction(ScriptAction action)`
`void`	`setScriptResponse(ScriptResponse response)`
`void`	`setServerObject(ServerObject<?> object)`
`void`	`setUserObject(UserObject<?> object)`
`void`	`start()`	Start the script, calling all events attached.

Method Details
- name
  
  String name()
- setExpected
  
  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.
- getExpected
  
  String getExpected()
  
  See setExpected(String)
- isDone
  
  boolean isDone()
  
  Has the script used start() and reached end()
- isPaused
  
  boolean isPaused()
  
  Is the script waiting for a response for resume(Number, Number, Object)
- isNextResponseSet
  
  boolean isNextResponseSet()
- isNextActionSet
  
  boolean isNextActionSet()
- hasPermission
  
  default boolean hasPermission()
  
  A check if this script has permission to run. This can be overridden to check if a user is valid for this script, or field, or whatever. This is called before start()
  
  Returns:
  
  - true if script can run
- start
  
  void start()
  
  Start the script, calling all events attached.
- end
  
  void end()
  
  End the script, calling all events attached.
- resume
  
  void resume(Number type, Number action, Object response)
  
  Resumes the scripts
  
  Parameters:
  
  type - - ScriptMessageType
  
  action - - The action for the type
  
  response - - The object to respond with
- escape
  
  void escape()
  
  Called if resume(Number, Number, Object)'s action matches the escape event, typically -1. If escape event is null, then end() is called.
- reset
  
  void reset()
  
  Resets the script back to a default state.
- resetAndStart
  
  default void resetAndStart()
- setScriptAction
  
  void setScriptAction(ScriptAction action)
- setScriptResponse
  
  void setScriptResponse(ScriptResponse response)
- addStartEvent
  
  void addStartEvent(ScriptEvent event)
  
  Called in start()
- addEndEvent
  
  void addEndEvent(ScriptEvent event)
  
  Called in end()
- addAfterRunEvent
  
  void addAfterRunEvent(ScriptEvent event)
  
  Called internally after the work method.
- addBeforeRunEvent
  
  void addBeforeRunEvent(ScriptEvent event)
  
  Called internally before the work method.
- addNoPermissionEvent
  
  void addNoPermissionEvent(ScriptEvent event)
  
  Called in start() if script fails hasPermission()
- setEscapeEvent
  
  void setEscapeEvent(ScriptEvent event)
  
  Called in resume(Number, Number, Object) if a user issues an escape action
- setInventorySlotObject
  
  void setInventorySlotObject(InventorySlotObject<?> itemSlot)
- setServerObject
  
  void setServerObject(ServerObject<?> object)
- setFieldObject
  
  void setFieldObject(FieldObject<?> object)
- setFieldSetObject
  
  void setFieldSetObject(FieldSetObject<?> object)
- setNpcObject
  
  void setNpcObject(NpcObject<?> object)
- setPortalObject
  
  void setPortalObject(PortalObject<?> object)
- setQuestObject
  
  void setQuestObject(QuestObject<?> object)
- setReactorObject
  
  void setReactorObject(ReactorObject<?> object)
- setUserObject
  
  void setUserObject(UserObject<?> object)
- getInventorySlotObject
  
  Optional<InventorySlotObject<?>> getInventorySlotObject()
- getServerObject
  
  Optional<ServerObject<?>> getServerObject()
- getFieldObject
  
  Optional<FieldObject<?>> getFieldObject()
- getFieldSetObject
  
  Optional<FieldSetObject<?>> getFieldSetObject()
- getNpcObject
  
  Optional<NpcObject<?>> getNpcObject()
- getPortalObject
  
  Optional<PortalObject<?>> getPortalObject()
- getQuestObject
  
  Optional<QuestObject<?>> getQuestObject()
- getReactorObject
  
  Optional<ReactorObject<?>> getReactorObject()
- getUserObject
  
  Optional<UserObject<?>> getUserObject()
- getSpeakerTemplateId
  
  default int getSpeakerTemplateId()
  
  Mainly used for packets. Maybe scripts will use this in say prompts or messages. If a script is going to speak, it needs a template id. Not all will speak, but this is useful for reasons. Can be overridden on a per-script basis.
  
  Returns:
  
  the NpcObject's template id or 2007, which is the id for maple administrator (I hope)

Interface MoeScript

Method Summary

Method Details