com.elmakers.mine.bukkit.api.action

Interface SpellAction

All Superinterfaces:

Cloneable

public interface SpellAction
extends Cloneable

Action lifecycle: On Config Load: initialize() On Cast: start() -> default implementation calls prepare() for backwards-compatibility (compound action) prepare() reset() perform() (parameter update) prepare()

Method Summary

Modifier and Type	Method and Description
Object	clone()
void	finish(CastContext context)
int	getActionCount()
void	getParameterNames(Spell spell, Collection<String> parameters)
void	getParameterOptions(Spell spell, String parameterKey, Collection<String> examples)
boolean	ignoreResult()
void	initialize(Spell spell, org.bukkit.configuration.ConfigurationSection baseParameters)
boolean	isUndoable()
default void	load(Mage mage, org.bukkit.configuration.ConfigurationSection data) Deprecated.
SpellResult	perform(CastContext context)
void	prepare(CastContext context, org.bukkit.configuration.ConfigurationSection parameters) This should be used to load any parameters.
boolean	requiresBreakPermission()
boolean	requiresBuildPermission()
boolean	requiresTarget()
boolean	requiresTargetEntity()
void	reset(CastContext context)
default void	save(Mage mage, org.bukkit.configuration.ConfigurationSection data) Deprecated.
default void	start(CastContext context, org.bukkit.configuration.ConfigurationSection parameters) This is called once per spell cast, at the start of the cast.
String	transformMessage(String message)
boolean	usesBrush()

Method Detail

perform

SpellResult perform(CastContext context)

initialize

void initialize(Spell spell,
                org.bukkit.configuration.ConfigurationSection baseParameters)

prepare

void prepare(CastContext context,
             org.bukkit.configuration.ConfigurationSection parameters)

This should be used to load any parameters. It is not a good idea to perform any logic or other initialization here, since this method can be called at other times in the spell's cast life cycle (see header comments)

start

default void start(CastContext context,
                   org.bukkit.configuration.ConfigurationSection parameters)

This is called once per spell cast, at the start of the cast. It is normally not needed, but can be used to reset or initialize any transient data.

finish

void finish(CastContext context)

reset

void reset(CastContext context)

getParameterNames

void getParameterNames(Spell spell,
                       Collection<String> parameters)

getParameterOptions

void getParameterOptions(Spell spell,
                         String parameterKey,
                         Collection<String> examples)

usesBrush

boolean usesBrush()

isUndoable

boolean isUndoable()

requiresBuildPermission

boolean requiresBuildPermission()

requiresBreakPermission

boolean requiresBreakPermission()

requiresTarget

boolean requiresTarget()

requiresTargetEntity

boolean requiresTargetEntity()

ignoreResult

boolean ignoreResult()

transformMessage

String transformMessage(String message)

getActionCount

int getActionCount()

clone

Object clone()

load

@Deprecated
default void load(Mage mage,
                              org.bukkit.configuration.ConfigurationSection data)

Deprecated.

This mechanism never worked properly and is no longer called. Actions that need to store data should interact with CastContext.getVariables instead.

save

@Deprecated
default void save(Mage mage,
                              org.bukkit.configuration.ConfigurationSection data)

Deprecated.

This mechanism never worked properly and is no longer called. Actions that need to store data should interact with CastContext.getVariables instead.