team.unnamed.creative.model

Interface Element.Builder

Enclosing interface:

Element

public static interface Element.Builder

A builder for Element instances.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
@NotNull Element.Builder	addFace(@NotNull CubeFace type, @NotNull ElementFace face) Adds a face to the element.
@NotNull Element	build() Builds the element.
default @NotNull Element.Builder	face(@NotNull CubeFace type, @NotNull ElementFace face) Deprecated. Use addFace(CubeFace, ElementFace) instead
@NotNull Element.Builder	faces(@NotNull java.util.Map<CubeFace,ElementFace> faces) Sets the element faces.
default @NotNull Element.Builder	from(float x, float y, float z) Sets the starting point of the element cuboid.
@NotNull Element.Builder	from(@NotNull Vector3Float from) Sets the starting point of the element cuboid.
@NotNull Element.Builder	rotation(@Nullable ElementRotation rotation) Sets the element rotation.
@NotNull Element.Builder	shade(boolean shade) Sets whether to render shadows for this element or not.
default @NotNull Element.Builder	to(float x, float y, float z) Sets the stop point of the element cuboid.
@NotNull Element.Builder	to(@NotNull Vector3Float to) Sets the stop point of the element cuboid.

Method Detail

from

@Contract(value="_ -> this")
 @NotNull
@NotNull Element.Builder from(@NotNull
                                                                       @NotNull Vector3Float from)

Sets the starting point of the element cuboid.

Parameters:

from - The cuboid origin

Returns:

This builder

Since:

1.0.0

from

@Contract(value="_, _, _ -> this")
 @NotNull
default @NotNull Element.Builder from(float x,
                                                                                     float y,
                                                                                     float z)

Sets the starting point of the element cuboid.

Parameters:

x - The x coordinate

y - The y coordinate

z - The z coordinate

Returns:

This builder

Since:

1.5.0

to

@Contract(value="_ -> this")
 @NotNull
@NotNull Element.Builder to(@NotNull
                                                                     @NotNull Vector3Float to)

Sets the stop point of the element cuboid.

Parameters:

to - The cuboid stop point

Returns:

This builder

Since:

1.0.0

to

@NotNull
default @NotNull Element.Builder to(float x,
                                              float y,
                                              float z)

Sets the stop point of the element cuboid.

Parameters:

x - The x coordinate

y - The y coordinate

z - The z coordinate

Returns:

This builder

Since:

1.5.0

rotation

@Contract(value="_ -> this")
 @NotNull
@NotNull Element.Builder rotation(@Nullable
                                                                           @Nullable ElementRotation rotation)

Sets the element rotation.

Parameters:

rotation - The element rotation

Returns:

This builder

Since:

1.0.0

shade

@Contract(value="_ -> this")
 @NotNull
@NotNull Element.Builder shade(boolean shade)

Sets whether to render shadows for this element or not.

Parameters:

shade - True to render shadows

Returns:

This builder

Since:

1.0.0

faces

@Contract(value="_ -> this")
 @NotNull
@NotNull Element.Builder faces(@NotNull
                                                                        @NotNull java.util.Map<CubeFace,ElementFace> faces)

Sets the element faces.

Parameters:

faces - The element faces

Returns:

This builder

Since:

1.0.0

addFace

@NotNull
@NotNull Element.Builder addFace(@NotNull
                                           @NotNull CubeFace type,
                                           @NotNull
                                           @NotNull ElementFace face)

Adds a face to the element.

Parameters:

type - Which face to add

face - The face data

Returns:

This builder

Since:

1.2.0

face

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @Contract(value="_, _ -> this")
 @NotNull
default @NotNull Element.Builder face(@NotNull
                                                                                                                                                    @NotNull CubeFace type,
                                                                                                                                                    @NotNull
                                                                                                                                                    @NotNull ElementFace face)

Deprecated. Use addFace(CubeFace, ElementFace) instead

Adds a face to the element.

Parameters:

type - Which face to add

face - The face data

Returns:

This builder

Since:

1.0.0

build

@Contract(value="-> new")
 @NotNull
@NotNull Element build()

Builds the element.

Returns:

The new element

Since:

1.0.0