Skip to main content

DevSink

A debug item meant for developers.

It is a spawnable non-flammable solid.

It has a malleability of 1000000.

At its default size (2x2x2) it has a durability of 100000000, at its maximum size it has a durability of 5000000000.

By default, its colour is #a3a3a3.

Methods


GetAmountConsumed(...) → ...

The variadic parameter is unknown. It can be anything.

The variadic return is unknown. It can be anything.


GetResource() → resource

Gets the name of the resource contained, will return the string "nil" if nothing is stored, rather than actually returning nil.

The resource return can be any of the following types:

  • string
  • "nil"

GetResourceAmount() → amount

Gives you the total amount of objects in the container.

The amount return is a number.


GetAmount() → amount

warning

This method is deprecated. Use :GetResourceAmount() instead.

Gives you the total amount of objects in the container.

The amount return is a number.

Configurables


Resource

The name of the object to produce a sink for. It is a ResourceString.

Events


Configured(configurerId)

Fires when the object is configured.

The configurerId parameter is the UserId of the player who configured the object. It is a number.


ContainerChanged(resourceType, resourceAmount)

Fires when the amount of the resource in the container changes.

The parameters for ContainerChanged are as follows:

  • The resourceType parameter is a string that can be Power, Solid, or Fluid
  • The resourceAmount parameter is a number.

OnClick(clickerId)

Fires when the object is clicked.

The clickerId parameter is the UserId of the player who clicked the object. It is a number.