Class ScriptedAbilityBuilder

java.lang.Object

de.gurkenlabs.litiengine.abilities.AbilityBuilder

de.gurkenlabs.litiengine.scripting.combat.ScriptedAbilityBuilder

public final class ScriptedAbilityBuilder
extends AbilityBuilder

Fluent builder for constructing and registering ScriptedAbility instances.

Constructor Summary

Constructors

Constructor	Description
ScriptedAbilityBuilder(Creature executor, String name)

Method Summary

Modifier and Type	Method	Description
ScriptedAbility	build()	Constructs a new ability without adding it to the executor.
ScriptedAbilityBuilder	castType(CastType castType)	Sets how the ability is cast.
ScriptedAbilityBuilder	cooldown(int cooldownMs)	Sets the cooldown after a successful cast.
ScriptedAbilityBuilder	description(String description)	Sets the player-facing description.
ScriptedAbilityBuilder	effect(Effect effect)	Adds an Effect to this ability.
ScriptedAbilityBuilder	impact(int impact)	Sets the base impact used by the ability's effects.
ScriptedAbilityBuilder	multiTarget(boolean multiTarget)	Sets whether one execution may affect multiple targets.
ScriptedAbilityBuilder	onCast(Runnable onCast)	Sets a callback that does not need the AbilityExecution details.
ScriptedAbilityBuilder	onCast(Consumer<AbilityExecution> onCast)	Sets the callback invoked when the ability is cast.
ScriptedAbilityBuilder	range(int range)	Sets the maximum cast range.
ScriptedAbilityBuilder	value(int value)	Sets the general-purpose value exposed through the ability attributes.

Methods inherited from class AbilityBuilder

register

Methods inherited from class Object

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

Constructor Details

ScriptedAbilityBuilder

public ScriptedAbilityBuilder(Creature executor,
 String name)

Method Details

description

public ScriptedAbilityBuilder description(String description)

Description copied from class: AbilityBuilder

Sets the player-facing description.

Overrides:

description in class AbilityBuilder

Parameters:

description - The description, or null to use an empty description.

Returns:

This builder.

cooldown

public ScriptedAbilityBuilder cooldown(int cooldownMs)

Description copied from class: AbilityBuilder

Sets the cooldown after a successful cast.

Overrides:

cooldown in class AbilityBuilder

Parameters:

cooldownMs - The cooldown in milliseconds; negative values are treated as zero.

Returns:

This builder.

range

public ScriptedAbilityBuilder range(int range)

Description copied from class: AbilityBuilder

Sets the maximum cast range.

Overrides:

range in class AbilityBuilder

Parameters:

range - The range in map units; negative values are treated as zero.

Returns:

This builder.

impact

public ScriptedAbilityBuilder impact(int impact)

Description copied from class: AbilityBuilder

Sets the base impact used by the ability's effects.

Overrides:

impact in class AbilityBuilder

Parameters:

impact - The impact value; negative values are treated as zero.

Returns:

This builder.

value

public ScriptedAbilityBuilder value(int value)

Description copied from class: AbilityBuilder

Sets the general-purpose value exposed through the ability attributes.

Overrides:

value in class AbilityBuilder

Parameters:

value - The value to expose; unlike the other numeric attributes this may be negative.

Returns:

This builder.

castType

public ScriptedAbilityBuilder castType(CastType castType)

Description copied from class: AbilityBuilder

Sets how the ability is cast.

Overrides:

castType in class AbilityBuilder

Parameters:

castType - The cast type.

Returns:

This builder.

multiTarget

public ScriptedAbilityBuilder multiTarget(boolean multiTarget)

Description copied from class: AbilityBuilder

Sets whether one execution may affect multiple targets.

Overrides:

multiTarget in class AbilityBuilder

Parameters:

multiTarget - true to permit multiple targets.

Returns:

This builder.

onCast

public ScriptedAbilityBuilder onCast(Consumer<AbilityExecution> onCast)

Description copied from class: AbilityBuilder

Sets the callback invoked when the ability is cast.

Overrides:

onCast in class AbilityBuilder

Parameters:

onCast - The callback, or null to remove the current callback.

Returns:

This builder.

onCast

public ScriptedAbilityBuilder onCast(Runnable onCast)

Description copied from class: AbilityBuilder

Sets a callback that does not need the AbilityExecution details.

Overrides:

onCast in class AbilityBuilder

Parameters:

onCast - The callback, or null to remove the current callback.

Returns:

This builder.

effect

public ScriptedAbilityBuilder effect(Effect effect)

Description copied from class: AbilityBuilder

Adds an Effect to this ability.

Overrides:

effect in class AbilityBuilder

Parameters:

effect - The effect to attach.

Returns:

This builder instance for chaining.

build

public ScriptedAbility build()

Description copied from class: AbilityBuilder

Constructs a new ability without adding it to the executor.

Each invocation returns a new ability configured from the builder's current values.

Overrides:

build in class AbilityBuilder

Returns:

A new, unregistered ability.

classabilitiesapijava