io.github.wysohn.triggerreactor.sponge.main

Class TriggerReactor

java.lang.Object

io.github.wysohn.triggerreactor.core.main.TriggerReactorCore

io.github.wysohn.triggerreactor.sponge.main.TriggerReactor

All Implemented Interfaces:

TaskSupervisor

public class TriggerReactor
extends TriggerReactorCore

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ID

Fields inherited from class io.github.wysohn.triggerreactor.core.main.TriggerReactorCore

CACHED_THREAD_POOL, PERMISSION, sharedVars

Constructor Summary

Constructors

Constructor and Description
TriggerReactor()

Method Summary

Modifier and Type	Method and Description
protected void	addItemLore(IItemStack iS, String lore)
void	callEvent(IEvent event) Call event so that it can be heard by listeners
<T> Future<T>	callSyncMethod(Callable<T> call) Run Callable on the server thread.
Object	createEmptyPlayerEvent(ICommandSender sender)
Interpreter.ProcessInterrupter	createInterrupter(Object e, Interpreter interpreter, Map<UUID,Long> cooldowns) Create ProcessInterrupter that will be used for the most of the Triggers.
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.
Object	createPlayerCommandEvent(ICommandSender sender, String label, String[] args)
void	disablePlugin() Disable this plugin.
IPlayer	extractPlayerFromContext(Object e) try to extract player from context 'e'.
AbstractAreaTriggerManager	getAreaManager()
String	getAuthor() get Author of plugin
AbstractLocationBasedTriggerManager<AbstractLocationBasedTriggerManager.ClickTrigger>	getClickManager()
AbstractCommandTriggerManager	getCmdManager()
Object	getConfig(String key) Get the saved value associated with 'key' in config.yml.
<T> T	getConfig(String key, T def) Get the saved value associated with 'key' in config.yml.
ICommandSender	getConsoleSender() get sender instance of the console
AbstractCustomTriggerManager	getCustomManager()
Map<String,Object>	getCustomVarsForTrigger(Object e) extract useful custom variables manually from 'context'
File	getDataFolder() Get folder where the plugin files will be saved.
AbstractExecutorManager	getExecutorManager()
AbstractInventoryEditManager	getInvEditManager()
AbstractInventoryTriggerManager	getInvManager()
AbstractPlayerLocationManager	getLocationManager()
Logger	getLogger() get Logger.
<T> T	getMain() Get the main class instance.
AbstractNamedTriggerManager	getNamedTriggerManager()
AbstractPermissionManager	getPermissionManager()
AbstractPlaceholderManager	getPlaceholderManager()
IPlayer	getPlayer(String string)
String	getPluginDescription() get Plugin's description.
AbstractRepeatingTriggerManager	getRepeatManager()
AbstractScriptEditManager	getScriptEditManager()
AbstractAreaSelectionManager	getSelectionManager()
SelfReference	getSelfReference()
Lag	getTpsHelper()
String	getVersion() get Plugin's version as String
AbstractLocationBasedTriggerManager<AbstractLocationBasedTriggerManager.WalkTrigger>	getWalkManager()
static SpongeWrapper	getWrapper()
boolean	isConfigSet(String key) Check if the 'key' is set in the config.yml.
boolean	isEnabled() Check if this plugin is enabled.
boolean	isServerThread() Check if the current Thread is the Server
void	onConstruct(org.spongepowered.api.event.game.state.GameInitializationEvent event)
void	onDisable(org.spongepowered.api.event.game.state.GameStoppingServerEvent e)
void	onEnable(org.spongepowered.api.event.game.state.GameStartedServerEvent e)
void	onInitialize(org.spongepowered.api.event.game.state.GameAboutToStartServerEvent e)
void	onLoadComplete(org.spongepowered.api.event.game.state.GameAboutToStartServerEvent e)
void	onReload(org.spongepowered.api.event.game.GameReloadEvent event)
void	onTabComplete(org.spongepowered.api.event.command.TabCompleteEvent.Command e)
void	registerEvents(Manager manager) Register events for Managers.
void	reloadConfig() Save all configs from config.yml.
protected boolean	removeLore(IItemStack iS, int index)
void	runTask(Runnable runnable) Run task on the server thread.
void	saveAsynchronously(Manager manager) Call saveAll() on separated thread.
void	saveConfig() Save all configs to config.yml.
protected void	sendCommandDesc(ICommandSender sender, String command, String desc) Send command description.
protected void	sendDetails(ICommandSender sender, String detail) Send detail under the command.
void	setConfig(String key, Object value) Save the 'value' to the associated 'key' in config.yml.
protected void	setItemTitle(IItemStack iS, String title)
protected boolean	setLore(IItemStack iS, int index, String lore)
protected void	showGlowStones(ICommandSender sender, Set<Map.Entry<SimpleLocation,Trigger>> set) Show glowstones to indicate the walk/click triggers in the chunk.

Methods inherited from class io.github.wysohn.triggerreactor.core.main.TriggerReactorCore

getInstance, getPluginConfigManager, getSharedVars, getVariableManager, handleException, handleException, isDebugging, onCommand, onCoreDisable, onCoreEnable, onTabComplete, submitAsync, submitSync

Methods inherited from class java.lang.Object

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

Field Detail

ID

protected static final String ID

See Also:

Constant Field Values

Constructor Detail

TriggerReactor

public TriggerReactor()

Method Detail

getWrapper

public static SpongeWrapper getWrapper()

onConstruct

public void onConstruct(org.spongepowered.api.event.game.state.GameInitializationEvent event)

getTpsHelper

public Lag getTpsHelper()

onLoadComplete

public void onLoadComplete(org.spongepowered.api.event.game.state.GameAboutToStartServerEvent e)

onInitialize

public void onInitialize(org.spongepowered.api.event.game.state.GameAboutToStartServerEvent e)

onEnable

public void onEnable(org.spongepowered.api.event.game.state.GameStartedServerEvent e)

onDisable

public void onDisable(org.spongepowered.api.event.game.state.GameStoppingServerEvent e)

onReload

public void onReload(org.spongepowered.api.event.game.GameReloadEvent event)

onTabComplete

public void onTabComplete(org.spongepowered.api.event.command.TabCompleteEvent.Command e)

getSelfReference

public SelfReference getSelfReference()

Specified by:

getSelfReference in class TriggerReactorCore

getExecutorManager

public AbstractExecutorManager getExecutorManager()

Specified by:

getExecutorManager in class TriggerReactorCore

getPlaceholderManager

public AbstractPlaceholderManager getPlaceholderManager()

Specified by:

getPlaceholderManager in class TriggerReactorCore

getScriptEditManager

public AbstractScriptEditManager getScriptEditManager()

Specified by:

getScriptEditManager in class TriggerReactorCore

getLocationManager

public AbstractPlayerLocationManager getLocationManager()

Specified by:

getLocationManager in class TriggerReactorCore

getPermissionManager

public AbstractPermissionManager getPermissionManager()

Specified by:

getPermissionManager in class TriggerReactorCore

getSelectionManager

public AbstractAreaSelectionManager getSelectionManager()

Specified by:

getSelectionManager in class TriggerReactorCore

getInvEditManager

public AbstractInventoryEditManager getInvEditManager()

Specified by:

getInvEditManager in class TriggerReactorCore

getClickManager

public AbstractLocationBasedTriggerManager<AbstractLocationBasedTriggerManager.ClickTrigger> getClickManager()

Specified by:

getClickManager in class TriggerReactorCore

getWalkManager

public AbstractLocationBasedTriggerManager<AbstractLocationBasedTriggerManager.WalkTrigger> getWalkManager()

Specified by:

getWalkManager in class TriggerReactorCore

getCmdManager

public AbstractCommandTriggerManager getCmdManager()

Specified by:

getCmdManager in class TriggerReactorCore

getInvManager

public AbstractInventoryTriggerManager getInvManager()

Specified by:

getInvManager in class TriggerReactorCore

getAreaManager

public AbstractAreaTriggerManager getAreaManager()

Specified by:

getAreaManager in class TriggerReactorCore

getCustomManager

public AbstractCustomTriggerManager getCustomManager()

Specified by:

getCustomManager in class TriggerReactorCore

getRepeatManager

public AbstractRepeatingTriggerManager getRepeatManager()

Specified by:

getRepeatManager in class TriggerReactorCore

getNamedTriggerManager

public AbstractNamedTriggerManager getNamedTriggerManager()

Specified by:

getNamedTriggerManager in class TriggerReactorCore

removeLore

protected boolean removeLore(IItemStack iS,
                             int index)

Specified by:

removeLore in class TriggerReactorCore

setLore

protected boolean setLore(IItemStack iS,
                          int index,
                          String lore)

Specified by:

setLore in class TriggerReactorCore

addItemLore

protected void addItemLore(IItemStack iS,
                           String lore)

Specified by:

addItemLore in class TriggerReactorCore

setItemTitle

protected void setItemTitle(IItemStack iS,
                            String title)

Specified by:

setItemTitle in class TriggerReactorCore

getPlayer

public IPlayer getPlayer(String string)

Specified by:

getPlayer in class TriggerReactorCore

createEmptyPlayerEvent

public Object createEmptyPlayerEvent(ICommandSender sender)

Specified by:

createEmptyPlayerEvent in class TriggerReactorCore

createPlayerCommandEvent

public Object createPlayerCommandEvent(ICommandSender sender,
                                       String label,
                                       String[] args)

Specified by:

createPlayerCommandEvent in class TriggerReactorCore

sendCommandDesc

protected void sendCommandDesc(ICommandSender sender,
                               String command,
                               String desc)

Description copied from class: TriggerReactorCore

Send command description.

Specified by:

sendCommandDesc in class TriggerReactorCore

Parameters:

sender - sender to show description

command - the command to explain

desc - description

sendDetails

protected void sendDetails(ICommandSender sender,
                           String detail)

Description copied from class: TriggerReactorCore

Send detail under the command. It is usually called after TriggerReactorCore.sendCommandDesc(ICommandSender, String, String) to add more information or example about the command.

Specified by:

sendDetails in class TriggerReactorCore

Parameters:

sender - sender to show description

detail - detail to show

getPluginDescription

public String getPluginDescription()

Description copied from class: TriggerReactorCore

get Plugin's description.

Specified by:

getPluginDescription in class TriggerReactorCore

Returns:

returns the full name of the plugin and its version.

getVersion

public String getVersion()

Description copied from class: TriggerReactorCore

get Plugin's version as String

Specified by:

getVersion in class TriggerReactorCore

Returns:

version of the plugin as String.

getAuthor

public String getAuthor()

Description copied from class: TriggerReactorCore

get Author of plugin

Specified by:

getAuthor in class TriggerReactorCore

Returns:

author name of the plugin as String.

showGlowStones

protected void showGlowStones(ICommandSender sender,
                              Set<Map.Entry<SimpleLocation,Trigger>> set)

Description copied from class: TriggerReactorCore

Show glowstones to indicate the walk/click triggers in the chunk. This should send block change packet instead of changing the real block.

Specified by:

showGlowStones in class TriggerReactorCore

Parameters:

sender - sender to show the glow stones

set - the set contains location of block and its associated trigger.

registerEvents

public void registerEvents(Manager manager)

Description copied from class: TriggerReactorCore

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.

Specified by:

registerEvents in class TriggerReactorCore

Parameters:

manager - the object instance of Manager

getDataFolder

public File getDataFolder()

Description copied from class: TriggerReactorCore

Get folder where the plugin files will be saved.

Specified by:

getDataFolder in class TriggerReactorCore

Returns:

folder to save plugin files.

getLogger

public Logger getLogger()

Description copied from class: TriggerReactorCore

get Logger.

Specified by:

getLogger in class TriggerReactorCore

Returns:

Logger.

isEnabled

public boolean isEnabled()

Description copied from class: TriggerReactorCore

Check if this plugin is enabled.

Specified by:

isEnabled in class TriggerReactorCore

Returns:

true if enabled; false if disabled.

disablePlugin

public void disablePlugin()

Description copied from class: TriggerReactorCore

Disable this plugin.

Specified by:

disablePlugin in class TriggerReactorCore

getMain

public <T> T getMain()

Description copied from class: TriggerReactorCore

Get the main class instance. JavaPlugin for Bukkit API for example.

Specified by:

getMain in class TriggerReactorCore

Returns:

isConfigSet

public boolean isConfigSet(String key)

Description copied from class: TriggerReactorCore

Check if the 'key' is set in the config.yml. This might be only case for Bukkit API

Specified by:

isConfigSet in class TriggerReactorCore

Parameters:

key - the key

Returns:

true if set; false if not set

setConfig

public void setConfig(String key,
                      Object value)

Description copied from class: TriggerReactorCore

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 TriggerReactorCore.saveConfig()

Specified by:

setConfig in class TriggerReactorCore

Parameters:

key - the key

value - the value to set.

getConfig

public Object getConfig(String key)

Description copied from class: TriggerReactorCore

Get the saved value associated with 'key' in config.yml. This might be only case for Bukkit API.

Specified by:

getConfig in class TriggerReactorCore

Parameters:

key - the key

Returns:

the value; null if not set.

getConfig

public <T> T getConfig(String key,
                       T def)

Description copied from class: TriggerReactorCore

Get the saved value associated with 'key' in config.yml. This might be only case for Bukkit API.

Specified by:

getConfig in class TriggerReactorCore

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 void saveConfig()

Description copied from class: TriggerReactorCore

Save all configs to config.yml.

Specified by:

saveConfig in class TriggerReactorCore

reloadConfig

public void reloadConfig()

Description copied from class: TriggerReactorCore

Save all configs from config.yml.

Specified by:

reloadConfig in class TriggerReactorCore

runTask

public void runTask(Runnable runnable)

Description copied from class: TriggerReactorCore

Run task on the server thread. Usually it happens via scheduler.

Specified by:

runTask in class TriggerReactorCore

Parameters:

runnable - the Runnable to run

saveAsynchronously

public void saveAsynchronously(Manager manager)

Description copied from class: TriggerReactorCore

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)

Specified by:

saveAsynchronously in class TriggerReactorCore

createInterrupter

public Interpreter.ProcessInterrupter createInterrupter(Object e,
                                                        Interpreter interpreter,
                                                        Map<UUID,Long> cooldowns)

Description copied from class: TriggerReactorCore

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.

Specified by:

createInterrupter in class TriggerReactorCore

Parameters:

e - the context

interpreter - the interpreter

cooldowns - list of current cooldowns.

Returns:

the interrupter created.

createInterrupterForInv

public Interpreter.ProcessInterrupter createInterrupterForInv(Object e,
                                                              Interpreter interpreter,
                                                              Map<UUID,Long> cooldowns,
                                                              Map<IInventory,InventoryTrigger> inventoryMap)

Description copied from class: TriggerReactorCore

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.

Specified by:

createInterrupterForInv in class TriggerReactorCore

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 IPlayer extractPlayerFromContext(Object e)

Description copied from class: TriggerReactorCore

try to extract player from context 'e'.

Specified by:

extractPlayerFromContext in class TriggerReactorCore

Parameters:

e - Event for Bukkit API

Returns:

callSyncMethod

public <T> Future<T> callSyncMethod(Callable<T> call)

Description copied from class: TriggerReactorCore

Run Callable on the server thread.

Specified by:

callSyncMethod in class TriggerReactorCore

Parameters:

call - the callable

Returns:

the future object.

callEvent

public void callEvent(IEvent event)

Description copied from class: TriggerReactorCore

Call event so that it can be heard by listeners

Specified by:

callEvent in class TriggerReactorCore

isServerThread

public boolean isServerThread()

Description copied from class: TriggerReactorCore

Check if the current Thread is the Server

Specified by:

isServerThread in class TriggerReactorCore

Returns:

getCustomVarsForTrigger

public Map<String,Object> getCustomVarsForTrigger(Object e)

Description copied from class: TriggerReactorCore

extract useful custom variables manually from 'context'

Specified by:

getCustomVarsForTrigger in class TriggerReactorCore

Returns:

getConsoleSender

public ICommandSender getConsoleSender()

Description copied from class: TriggerReactorCore

get sender instance of the console

Specified by:

getConsoleSender in class TriggerReactorCore

Returns: