Class ScriptedSpawner.PropBuilder

java.lang.Object

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

de.gurkenlabs.litiengine.scripting.ScriptedSpawner.PropBuilder

Enclosing class:

ScriptedSpawner

public static final class ScriptedSpawner.PropBuilder
extends ScriptedSpawner.EntityBuilder<Prop>

Type-preserving builder for props.

Field Summary

Fields inherited from class ScriptedSpawner.EntityBuilder

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

Constructor Summary

Constructors

Constructor	Description
PropBuilder(Environment env, String spriteSheet)	Creates a prop builder.

Method Summary

Modifier and Type	Method	Description
ScriptedSpawner.PropBuilder	at(double x, double y)	Sets the spawn coordinates.
ScriptedSpawner.PropBuilder	at(Point2D location)	Sets the spawn location.
ScriptedSpawner.PropBuilder	configure(Consumer<Prop> customizer)	Sets an operation invoked after standard configuration but before insertion.
ScriptedSpawner.PropBuilder	withName(String name)	Sets the entity name.
ScriptedSpawner.PropBuilder	withTags(String... tags)	Sets tags to add to the entity.

Methods inherited from class ScriptedSpawner.EntityBuilder

spawn, withHealth, withRenderType

Methods inherited from class Object

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

Constructor Details

PropBuilder

public PropBuilder(Environment env,
 String spriteSheet)

Creates a prop builder.

Parameters:

env - The destination environment.

spriteSheet - The spritesheet name.

Method Details

at

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

Description copied from class: ScriptedSpawner.EntityBuilder

Sets the spawn coordinates.

Overrides:

at in class ScriptedSpawner.EntityBuilder<Prop>

Parameters:

x - The map x-coordinate.

y - The map y-coordinate.

Returns:

This builder.

at

public ScriptedSpawner.PropBuilder at(Point2D location)

Description copied from class: ScriptedSpawner.EntityBuilder

Sets the spawn location.

Overrides:

at in class ScriptedSpawner.EntityBuilder<Prop>

Parameters:

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

Returns:

This builder.

withName

public ScriptedSpawner.PropBuilder withName(String name)

Description copied from class: ScriptedSpawner.EntityBuilder

Sets the entity name.

Overrides:

withName in class ScriptedSpawner.EntityBuilder<Prop>

Parameters:

name - The name to assign.

Returns:

This builder.

withTags

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

Description copied from class: ScriptedSpawner.EntityBuilder

Sets tags to add to the entity.

Overrides:

withTags in class ScriptedSpawner.EntityBuilder<Prop>

Parameters:

tags - The tags; null entries are ignored.

Returns:

This builder.

configure

public ScriptedSpawner.PropBuilder configure(Consumer<Prop> customizer)

Description copied from class: ScriptedSpawner.EntityBuilder

Sets an operation invoked after standard configuration but before insertion.

Overrides:

configure in class ScriptedSpawner.EntityBuilder<Prop>

Parameters:

customizer - The customizer, or null for none.

Returns:

This builder.

classapijava