GenericItemBuilder
An abstract Builder for all Items.
Reference
Methods
createdUserId
createdUserId(createdUserId);
Set the items createdUserId uuid.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| createdUserId | string | The created user ID |
Returns the current builder.
id
id(id);
Set the items id uuid.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| id | string | The ID |
Returns the current builder.
name
name(name: string)
Set the items name.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| name | string | The name |
Returns the current builder.
description
description(description: string)
Set the items description.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| description | string | The description |
Returns the current builder.
lastModified
lastModified(lastModified);
Set the items lastModified ISO time.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| lastModified | string | The lat modified time |
Returns the current builder.
zIndex
zIndex(zIndex);
Set the items zIndex.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| zIndex | number | The z-index |
Returns the current builder.
lastModifiedUserId
lastModifiedUserId(lastModifiedUserId);
Set the items lastModifiedUserId uuid.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| lastModifiedUserId | string | The ID of the last modified user |
Returns the current builder.
locked
locked(locked);
Set the items locked boolean.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| locked | boolean | The locked setting |
Returns the current builder.
metadata
metadata(metadata);
Set the items metadata.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| metadata | Metadata | The metadata |
Returns the current builder.
position
position(position);
Set the items position.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| position | Vector2 | The position |
Returns the current builder.
rotation
rotation(rotation);
Set the items rotation in degrees.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| rotation | number | The rotation in degrees |
Returns the current builder.
scale
scale(scale);
Set the items scale.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| scale | Vector2 | The scale |
Returns the current builder.
visible
visible(visible);
Set the items visible boolean.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| visible | boolean | The visible setting |
Returns the current builder.
attachedTo
attachedTo(attachedTo);
Set the items attachedTo uuid.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| attachedTo | string | The attached to ID |
Returns the current builder.
layer
layer(layer);
Set the items layer.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| layer | Layer | The layer |
Returns the current builder.
disableHit
disableHit(disable))
Set the items disableHit property.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| disableHit | boolean | The disable hit setting |
Returns the current builder.
disableAutoZIndex
disableAutoZIndex(disable))
Set the items disableAutoZIndex property.
Parameters
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| disableAutoZIndex | boolean | The disable auto z-index setting |
Returns the current builder.