Below is a list of resources developers can use to modify or tap into core functions of the addon.
| Name |
Scope |
Arguments |
Returns |
Description |
| CraftingTable:AddItem |
Server |
String ingredient, Number amount |
N/A |
Add the specified ingredient to the table. Set amount as negative to subtract. |
| CraftingTable:GetData |
Shared |
N/A |
Table data |
Returns the table that defines all of the crafting table's properties. |
| CraftingTable:GetItemAmount |
Server |
String ingredient |
Number amount |
Returns the number of the specified ingredient currently on the table. |
| CraftingTable:GetTableType |
Shared |
N/A |
String type |
Returns the type assigned to the table. |
| MineableEntity:GetData |
Shared |
N/A |
Table data |
Returns the table that defines all of the mineable entity's properties. |
| MineableEntity:GetMineableType |
Shared |
N/A |
String type |
Returns the type assigned to the mineable entity. |
| MineableEntity:Hide |
Server |
N/A |
N/A |
Makes the entity invisible and non-solid, and starts a timer to respawn it. |
| MineableEntity:Show |
Server |
N/A |
N/A |
Makes the entity visible and solid again, and calls the UCS_OnMineableRespawned hook. |
| Name |
Scope |
Arguments |
Returns |
Description |
| UCS_CanCraft |
Server |
Entity table, Player user, Table recipe |
Bool canCraft |
Return false to prevent the player from crafting the specified item. |
| UCS_CanUseTable |
Server |
Entity table, Player user |
Bool canUse |
Return false to prevent the player from using the table. |
| UCS_OnCrafted |
Server |
Entity table, Player user, Table recipe, Entity craftedItem |
N/A |
Called when an item has been successfully crafted. |
| UCS_OnAddIngredient |
Server |
Entity table, Entity ingredient |
N/A |
Called when a crafting ingredient is touched and added to a crafting table. |
| UCS_OnDropIngredient |
Server |
Entity table, Player user, Entity ingredient |
N/A |
Called when a crafting ingredient is manually removed from the table. |
| UCS_OnMineableMined |
Server |
Entity mineable, Player miner |
N/A |
Called when a player mines something. |
| UCS_OnMineableRespawned |
Server |
Entity mineable |
N/A |
Called when a mined entity is respawned. |