TriggerReactorCore (TriggerReactor API)

java.lang.Object
- io.github.wysohn.triggerreactor.core.main.TriggerReactorCore

All Implemented Interfaces:

TaskSupervisor

Direct Known Subclasses:

BukkitTriggerReactorCore, TriggerReactor
```
public abstract class TriggerReactorCore
extends Object
implements TaskSupervisor
```
The main abstract class of TriggerReactor. Interacting with any platform should extends this class to create important internal components.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static ExecutorService`	`CACHED_THREAD_POOL` Cached Pool for thread execution.
`static String`	`PERMISSION`
`protected Map<String,AbstractAPISupport>`	`sharedVars`

Constructor Summary

Constructors
Modifier Constructor and Description

protected TriggerReactorCore()

Constructors
Modifier	Constructor and Description
`protected`	`TriggerReactorCore()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected abstract void`	`addItemLore(IItemStack iS, String lore)`
`abstract void`	`callEvent(IEvent event)` Call event so that it can be heard by listeners
`abstract <T> Future<T>`	`callSyncMethod(Callable<T> call)` Run Callable on the server thread.
`abstract Object`	`createEmptyPlayerEvent(ICommandSender sender)`
`abstract Interpreter.ProcessInterrupter`	`createInterrupter(Object e, Interpreter interpreter, Map<UUID,Long> cooldowns)` Create ProcessInterrupter that will be used for the most of the Triggers.
`abstract Interpreter.ProcessInterrupter`	`createInterrupterForInv(Object e, Interpreter interpreter, Map<UUID,Long> cooldowns, Map<IInventory,InventoryTrigger> inventoryMap)` Create ProcessInterrupter that will be used for the most of the Triggers.
`abstract Object`	`createPlayerCommandEvent(ICommandSender sender, String label, String[] args)`
`abstract void`	`disablePlugin()` Disable this plugin.
`abstract IPlayer`	`extractPlayerFromContext(Object e)` try to extract player from context 'e'.
`abstract AbstractAreaTriggerManager`	`getAreaManager()`
`abstract String`	`getAuthor()` get Author of plugin
`abstract AbstractLocationBasedTriggerManager<AbstractLocationBasedTriggerManager.ClickTrigger>`	`getClickManager()`
`abstract AbstractCommandTriggerManager`	`getCmdManager()`
`abstract Object`	`getConfig(String key)` Get the saved value associated with 'key' in config.yml.
`abstract <T> T`	`getConfig(String key, T def)` Get the saved value associated with 'key' in config.yml.
`abstract ICommandSender`	`getConsoleSender()` get sender instance of the console
`abstract AbstractCustomTriggerManager`	`getCustomManager()`
`abstract Map<String,Object>`	`getCustomVarsForTrigger(Object context)` extract useful custom variables manually from 'context'
`abstract File`	`getDataFolder()` Get folder where the plugin files will be saved.
`abstract AbstractExecutorManager`	`getExecutorManager()`
`static TriggerReactorCore`	`getInstance()` get instance of this class.
`abstract AbstractInventoryEditManager`	`getInvEditManager()`
`abstract AbstractInventoryTriggerManager<? extends IInventory>`	`getInvManager()`
`abstract AbstractPlayerLocationManager`	`getLocationManager()`
`abstract Logger`	`getLogger()` get Logger.
`abstract <T> T`	`getMain()` Get the main class instance.
`abstract AbstractNamedTriggerManager`	`getNamedTriggerManager()`
`abstract AbstractPermissionManager`	`getPermissionManager()`
`abstract AbstractPlaceholderManager`	`getPlaceholderManager()`
`abstract IPlayer`	`getPlayer(String string)`
`PluginConfigManager`	`getPluginConfigManager()`
`abstract String`	`getPluginDescription()` get Plugin's description.
`abstract AbstractRepeatingTriggerManager`	`getRepeatManager()`
`abstract AbstractScriptEditManager`	`getScriptEditManager()`
`abstract AbstractAreaSelectionManager`	`getSelectionManager()`
`abstract SelfReference`	`getSelfReference()`
`Map<String,AbstractAPISupport>`	`getSharedVars()`
`GlobalVariableManager`	`getVariableManager()`
`abstract String`	`getVersion()` get Plugin's version as String
`abstract AbstractLocationBasedTriggerManager<AbstractLocationBasedTriggerManager.WalkTrigger>`	`getWalkManager()`
`void`	`handleException(ICommandSender sender, Throwable throwable)` Handle the exception caused by Executors or Triggers.
`void`	`handleException(Object e, Throwable throwable)` Handle the exception caused by Executors or Triggers.
`abstract boolean`	`isConfigSet(String key)` Check if the 'key' is set in the config.yml.
`boolean`	`isDebugging()`
`abstract boolean`	`isEnabled()` Check if this plugin is enabled.
`abstract boolean`	`isServerThread()` Check if the current Thread is the Server
`boolean`	`onCommand(ICommandSender sender, String command, String[] args)`
`void`	`onCoreDisable()`
`void`	`onCoreEnable()`
`static List<String>`	`onTabComplete(ICommandSender sender, String[] args)`
`abstract void`	`registerEvents(Manager manager)` Register events for Managers.
`abstract void`	`reloadConfig()` Save all configs from config.yml.
`protected abstract boolean`	`removeLore(IItemStack iS, int index)`
`abstract void`	`runTask(Runnable runnable)` Run task on the server thread.
`abstract void`	`saveAsynchronously(Manager manager)` Call saveAll() on separated thread.
`abstract void`	`saveConfig()` Save all configs to config.yml.
`protected abstract void`	`sendCommandDesc(ICommandSender sender, String command, String desc)` Deprecated. no longer used
`protected abstract void`	`sendDetails(ICommandSender sender, String detail)` Deprecated. no longer used
`abstract void`	`setConfig(String key, Object value)` Save the 'value' to the associated 'key' in config.yml.
`protected abstract void`	`setItemTitle(IItemStack iS, String title)`
`protected abstract boolean`	`setLore(IItemStack iS, int index, String lore)`
`protected abstract void`	`showGlowStones(ICommandSender sender, Set<Map.Entry<SimpleLocation,Trigger>> set)` Show glowstones to indicate the walk/click triggers in the chunk.
`void`	`submitAsync(Runnable run)` Execute the task asynchronously on separate thread.
`<T> Future<T>`	`submitSync(Callable<T> call)` Execute the task synchronously if possible.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PERMISSION
```
public static final String PERMISSION
```
    See Also:
    
    Constant Field Values
  - sharedVars
```
protected Map<String,AbstractAPISupport> sharedVars
```
  - CACHED_THREAD_POOL
```
protected static final ExecutorService CACHED_THREAD_POOL
```
    Cached Pool for thread execution.
- Constructor Detail
  - TriggerReactorCore
```
protected TriggerReactorCore()
```
- Method Detail
  - getSharedVars
```
public Map<String,AbstractAPISupport> getSharedVars()
```
  - getSelfReference
```
public abstract SelfReference getSelfReference()
```
  - getExecutorManager
```
public abstract AbstractExecutorManager getExecutorManager()
```
  - getPlaceholderManager
```
public abstract AbstractPlaceholderManager getPlaceholderManager()
```
  - getScriptEditManager
```
public abstract AbstractScriptEditManager getScriptEditManager()
```
  - getLocationManager
```
public abstract AbstractPlayerLocationManager getLocationManager()
```
  - getPermissionManager
```
public abstract AbstractPermissionManager getPermissionManager()
```
  - getSelectionManager
```
public abstract AbstractAreaSelectionManager getSelectionManager()
```
  - getClickManager
```
public abstract AbstractLocationBasedTriggerManager<AbstractLocationBasedTriggerManager.ClickTrigger> getClickManager()
```
  - getWalkManager
```
public abstract AbstractLocationBasedTriggerManager<AbstractLocationBasedTriggerManager.WalkTrigger> getWalkManager()
```
  - getCmdManager
```
public abstract AbstractCommandTriggerManager getCmdManager()
```
  - getInvManager
```
public abstract AbstractInventoryTriggerManager<? extends IInventory> getInvManager()
```
  - getInvEditManager
```
public abstract AbstractInventoryEditManager getInvEditManager()
```
  - getAreaManager
```
public abstract AbstractAreaTriggerManager getAreaManager()
```
  - getCustomManager
```
public abstract AbstractCustomTriggerManager getCustomManager()
```
  - getRepeatManager
```
public abstract AbstractRepeatingTriggerManager getRepeatManager()
```
  - getNamedTriggerManager
```
public abstract AbstractNamedTriggerManager getNamedTriggerManager()
```
  - getPluginConfigManager
```
public final PluginConfigManager getPluginConfigManager()
```
  - getVariableManager
```
public final GlobalVariableManager getVariableManager()
```
  - onCoreEnable
```
public void onCoreEnable()
```
  - onCoreDisable
```
public void onCoreDisable()
```
  - removeLore
```
protected abstract boolean removeLore(IItemStack iS,
                                      int index)
```
  - setLore
```
protected abstract boolean setLore(IItemStack iS,
                                   int index,
                                   String lore)
```
  - addItemLore
```
protected abstract void addItemLore(IItemStack iS,
                                    String lore)
```
  - setItemTitle
```
protected abstract void setItemTitle(IItemStack iS,
                                     String title)
```
  - getPlayer
```
public abstract IPlayer getPlayer(String string)
```
  - createEmptyPlayerEvent
```
public abstract Object createEmptyPlayerEvent(ICommandSender sender)
```
  - createPlayerCommandEvent
```
public abstract Object createPlayerCommandEvent(ICommandSender sender,
                                                String label,
                                                String[] args)
```
  - sendCommandDesc
```
@Deprecated
protected abstract void sendCommandDesc(ICommandSender sender,
                                                    String command,
                                                    String desc)
```
    Deprecated. no longer used
    
    Send command description.
    
    Parameters:
    
    sender - sender to show description
    
    command - the command to explain
    
    desc - description
  - sendDetails
```
@Deprecated
protected abstract void sendDetails(ICommandSender sender,
                                                String detail)
```
    Deprecated. no longer used
    
    Send detail under the command. It is usually called after sendCommandDesc(ICommandSender, String, String) to add more information or example about the command.
    
    Parameters:
    
    sender - sender to show description
    
    detail - detail to show
  - getPluginDescription
```
public abstract String getPluginDescription()
```
    get Plugin's description.
    
    Returns:
    
    returns the full name of the plugin and its version.
  - getVersion
```
public abstract String getVersion()
```
    get Plugin's version as String
    
    Returns:
    
    version of the plugin as String.
  - getAuthor
```
public abstract String getAuthor()
```
    get Author of plugin
    
    Returns:
    
    author name of the plugin as String.
  - isDebugging
```
public boolean isDebugging()
```
  - showGlowStones
```
protected abstract void showGlowStones(ICommandSender sender,
                                       Set<Map.Entry<SimpleLocation,Trigger>> set)
```
    Show glowstones to indicate the walk/click triggers in the chunk. This should send block change packet instead of changing the real block.
    
    Parameters:
    
    sender - sender to show the glow stones
    
    set - the set contains location of block and its associated trigger.
  - registerEvents
```
public abstract void registerEvents(Manager manager)
```
    Register events for Managers. If it was Bukkit API, we can assume that the 'manager' will implement Listener interface, yet we need to verify it with instanceof to avoid any problems.
    
    Parameters:
    
    manager - the object instance of Manager
  - getDataFolder
```
public abstract File getDataFolder()
```
    Get folder where the plugin files will be saved.
    
    Returns:
    
    folder to save plugin files.
  - getLogger
```
public abstract Logger getLogger()
```
    get Logger.
    
    Returns:
    
    Logger.
  - isEnabled
```
public abstract boolean isEnabled()
```
    Check if this plugin is enabled.
    
    Returns:
    
    true if enabled; false if disabled.
  - disablePlugin
```
public abstract void disablePlugin()
```
    Disable this plugin.
  - getMain
```
public abstract <T> T getMain()
```
    Get the main class instance. JavaPlugin for Bukkit API for example.
    
    Returns:
  - isConfigSet
```
public abstract boolean isConfigSet(String key)
```
    Check if the 'key' is set in the config.yml. This might be only case for Bukkit API
    
    Parameters:
    
    key - the key
    
    Returns:
    
    true if set; false if not set
  - setConfig
```
public abstract void setConfig(String key,
                               Object value)
```
    Save the 'value' to the associated 'key' in config.yml. This might be only case for Bukkit API. The new value should override the value if already exists. This does not actually save values into config.yml unless you invoke saveConfig()
    
    Parameters:
    
    key - the key
    
    value - the value to set.
  - getConfig
```
public abstract Object getConfig(String key)
```
    Get the saved value associated with 'key' in config.yml. This might be only case for Bukkit API.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the value; null if not set.
  - getConfig
```
public abstract <T> T getConfig(String key,
                                T def)
```
    Get the saved value associated with 'key' in config.yml. This might be only case for Bukkit API.
    
    Parameters:
    
    key - the key
    
    def - the default value to return if the 'key' is not set
    
    Returns:
    
    the value; null if not set.
  - saveConfig
```
public abstract void saveConfig()
```
    Save all configs to config.yml.
  - reloadConfig
```
public abstract void reloadConfig()
```
    Save all configs from config.yml.
  - runTask
```
public abstract void runTask(Runnable runnable)
```
    Run task on the server thread. Usually it happens via scheduler.
    
    Parameters:
    
    runnable - the Runnable to run
  - saveAsynchronously
```
public abstract void saveAsynchronously(Manager manager)
```
    Call saveAll() on separated thread. It should also check if a saving task is already happening with the 'manager.' (As it will cause concurrency issue without the proper check up)
    
    Parameters:
    
    manager -
  - handleException
```
public final void handleException(Object e,
                                  Throwable throwable)
```
    Handle the exception caused by Executors or Triggers. The 'e' is the context when the 'event' was happened. For Bukkit API, it is child classes of Event. You may extract the player instance who is related to this Exception and show useful information to the game.
    
    Parameters:
    
    e - the context
    
    throwable - the exception that was thrown
  - handleException
```
public final void handleException(ICommandSender sender,
                                  Throwable throwable)
```
    Handle the exception caused by Executors or Triggers.
    
    Parameters:
    
    sender - the sender who will receive the message
    
    throwable - the exception that was thrown
  - getConsoleSender
```
public abstract ICommandSender getConsoleSender()
```
    get sender instance of the console
    
    Returns:
  - createInterrupter
```
public abstract Interpreter.ProcessInterrupter createInterrupter(Object e,
                                                                 Interpreter interpreter,
                                                                 Map<UUID,Long> cooldowns)
```
    Create ProcessInterrupter that will be used for the most of the Triggers. It is responsible for this interrupter to handle cooldowns, CALL executor, etc, that has to be processed during the iterpretation.
    
    Parameters:
    
    e - the context
    
    interpreter - the interpreter
    
    cooldowns - list of current cooldowns.
    
    Returns:
    
    the interrupter created.
  - createInterrupterForInv
```
public abstract Interpreter.ProcessInterrupter createInterrupterForInv(Object e,
                                                                       Interpreter interpreter,
                                                                       Map<UUID,Long> cooldowns,
                                                                       Map<IInventory,InventoryTrigger> inventoryMap)
```
    Create ProcessInterrupter that will be used for the most of the Triggers. It is responsible for this interrupter to handle cooldowns, CALL executor, etc, that has to be processed during the interpretation. This method exists specifically for Inventory Trigger. As Inventory Trigger should stop at some point when the Inventory was closed, it is the iterrupter's responsibility to do that.
    
    Parameters:
    
    e - the context
    
    interpreter - the interpreter
    
    cooldowns - list of current cooldowns.
    
    inventoryMap - the inventory map that contains all the information about open inventories. As child class that implements IIventory should override hashCode() and equals() methods, you can assume that each IInventory instance represents one trigger that is running with the InventoryTrigger mapped. So it is ideal to get inventory object from the 'e' context and see if the Inventory object exists in the 'inventoryMap.' For the properly working InventoryTriggerManager, closing the inventory should delete the IInventory from the 'inventoryMap,' so you can safely assume that closed inventory will not exists in the 'inventoryMap.'
    
    Returns:
  - extractPlayerFromContext
```
public abstract IPlayer extractPlayerFromContext(Object e)
```
    try to extract player from context 'e'.
    
    Parameters:
    
    e - Event for Bukkit API
    
    Returns:
  - callSyncMethod
```
public abstract <T> Future<T> callSyncMethod(Callable<T> call)
```
    Run Callable on the server thread.
    
    Parameters:
    
    call - the callable
    
    Returns:
    
    the future object.
  - submitSync
```
public <T> Future<T> submitSync(Callable<T> call)
```
    Description copied from interface: TaskSupervisor
    
    Execute the task synchronously if possible. The task Supervisor should check if the caller thread is Server or not and schedule the task appropriately.
    
    Specified by:
    
    submitSync in interface TaskSupervisor
    
    Parameters:
    
    call - the task to be done on server thread
    
    Returns:
    
    future instance
  - submitAsync
```
public void submitAsync(Runnable run)
```
    Description copied from interface: TaskSupervisor
    
    Execute the task asynchronously on separate thread. Regardless of the caller thread (either server or separate thread), it will always spawn a new thread that will run concurrently.
    
    Specified by:
    
    submitAsync in interface TaskSupervisor
    
    Parameters:
    
    run - the task to be done on separate thread
  - callEvent
```
public abstract void callEvent(IEvent event)
```
    Call event so that it can be heard by listeners
    
    Parameters:
    
    event -
  - isServerThread
```
public abstract boolean isServerThread()
```
    Check if the current Thread is the Server
    
    Returns:
  - getCustomVarsForTrigger
```
public abstract Map<String,Object> getCustomVarsForTrigger(Object context)
```
    extract useful custom variables manually from 'context'
    
    Parameters:
    
    context -
    
    Returns:
  - onCommand
```
public boolean onCommand(ICommandSender sender,
                         String command,
                         String[] args)
```
  - getInstance
```
public static TriggerReactorCore getInstance()
```
    get instance of this class.
    
    Returns:
  - onTabComplete
```
public static List<String> onTabComplete(ICommandSender sender,
                                         String[] args)
```

Class TriggerReactorCore

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PERMISSION

sharedVars

CACHED_THREAD_POOL

Constructor Detail

TriggerReactorCore

Method Detail

getSharedVars

getSelfReference

getExecutorManager

getPlaceholderManager

getScriptEditManager

getLocationManager

getPermissionManager

getSelectionManager

getClickManager

getWalkManager

getCmdManager

getInvManager

getInvEditManager

getAreaManager

getCustomManager

getRepeatManager

getNamedTriggerManager

getPluginConfigManager

getVariableManager

onCoreEnable

onCoreDisable

removeLore

setLore

addItemLore

setItemTitle

getPlayer

createEmptyPlayerEvent

createPlayerCommandEvent

sendCommandDesc

sendDetails

getPluginDescription

getVersion

getAuthor

isDebugging

showGlowStones

registerEvents

getDataFolder

getLogger

isEnabled

disablePlugin

getMain

isConfigSet

setConfig

getConfig

getConfig

saveConfig

reloadConfig

runTask

saveAsynchronously

handleException

handleException

getConsoleSender

createInterrupter

createInterrupterForInv

extractPlayerFromContext

callSyncMethod

submitSync

submitAsync

callEvent

isServerThread

getCustomVarsForTrigger

onCommand

getInstance

onTabComplete