Class ScriptedSpawner.CreatureBuilder

java.lang.Object

de.gurkenlabs.litiengine.scripting.ScriptedSpawner.EntityBuilder<Creature>

de.gurkenlabs.litiengine.scripting.ScriptedSpawner.CreatureBuilder

Enclosing class:

ScriptedSpawner

public static final class ScriptedSpawner.CreatureBuilder
extends ScriptedSpawner.EntityBuilder<Creature>

Type-preserving builder for creatures.

Field Summary

Fields inherited from class ScriptedSpawner.EntityBuilder

customizer, env, factory, health, location, name, renderType, tags

Constructor Summary

Constructors

Constructor	Description
CreatureBuilder(Environment env, String spritePrefix)	Creates a creature builder.

Method Summary

Modifier and Type	Method	Description
ScriptedSpawner.CreatureBuilder	at(double x, double y)	Sets the spawn coordinates.
ScriptedSpawner.CreatureBuilder	at(Point2D location)	Sets the spawn location.
ScriptedSpawner.CreatureBuilder	configure(Consumer<Creature> customizer)	Sets an operation invoked after standard configuration but before insertion.
ScriptedSpawner.CreatureBuilder	withHealth(int health)	Sets current and maximum hit points when the entity supports combat.
ScriptedSpawner.CreatureBuilder	withName(String name)	Sets the entity name.
ScriptedSpawner.CreatureBuilder	withTags(String... tags)	Sets tags to add to the entity.

Methods inherited from class ScriptedSpawner.EntityBuilder

spawn, withRenderType

Methods inherited from class Object

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

Constructor Details

CreatureBuilder

public CreatureBuilder(Environment env,
 String spritePrefix)

Creates a creature builder.

Parameters:

env - The destination environment.

spritePrefix - The animation sprite prefix.

Method Details

at

public ScriptedSpawner.CreatureBuilder at(double x,
 double y)

Description copied from class: ScriptedSpawner.EntityBuilder

Sets the spawn coordinates.

Overrides:

at in class ScriptedSpawner.EntityBuilder<Creature>

Parameters:

x - The map x-coordinate.

y - The map y-coordinate.

Returns:

This builder.

at

public ScriptedSpawner.CreatureBuilder at(Point2D location)

Description copied from class: ScriptedSpawner.EntityBuilder

Sets the spawn location.

Overrides:

at in class ScriptedSpawner.EntityBuilder<Creature>

Parameters:

location - The location in map coordinates; null leaves it unchanged.

Returns:

This builder.

withName

public ScriptedSpawner.CreatureBuilder withName(String name)

Description copied from class: ScriptedSpawner.EntityBuilder

Sets the entity name.

Overrides:

withName in class ScriptedSpawner.EntityBuilder<Creature>

Parameters:

name - The name to assign.

Returns:

This builder.

withTags

public ScriptedSpawner.CreatureBuilder withTags(String... tags)

Description copied from class: ScriptedSpawner.EntityBuilder

Sets tags to add to the entity.

Overrides:

withTags in class ScriptedSpawner.EntityBuilder<Creature>

Parameters:

tags - The tags; null entries are ignored.

Returns:

This builder.

withHealth

public ScriptedSpawner.CreatureBuilder withHealth(int health)

Description copied from class: ScriptedSpawner.EntityBuilder

Sets current and maximum hit points when the entity supports combat.

Overrides:

withHealth in class ScriptedSpawner.EntityBuilder<Creature>

Parameters:

health - The hit-point value.

Returns:

This builder.

configure

public ScriptedSpawner.CreatureBuilder configure(Consumer<Creature> customizer)

Description copied from class: ScriptedSpawner.EntityBuilder

Sets an operation invoked after standard configuration but before insertion.

Overrides:

configure in class ScriptedSpawner.EntityBuilder<Creature>

Parameters:

customizer - The customizer, or null for none.

Returns:

This builder.

classentitiesapijava