Context

Get some context about the current crafting process

Context is the object provided in the function requirement using the Crafttweaker integration.

It contains various methods for interacting with the machine.

Methods

Set the result of the function

Every function MUST return a result, which is either a success or an error.

//Get a success result
ctx.success();

//Get an error result
ctx.error("Some error message");

Get the remaining crafting time

Name : remainingTime

Description :

Return a decimal value that represent the time in ticks before the end of the current recipe process. This value does not take into account any speed modifiers applied to the machine.

Note : This method won't work when used inside requireFunctionToStart, the other 3 function requirements are fine to use.

Example

.requireFunctionEachTick((ctx as Context) => {
		var time = ctx.remainingTime;
                //Use time here
	})

Get the crafting process base speed

Name : baseSpeed

Description :

Return a decimal value that represent the base speed (before upgrades are applied) of the crafting process.

By default it returns 1

Note : This method won't work when used inside requireFunctionToStart, the other 3 function requirements are fine to use.

Example

.requireFunctionEachTick((ctx as Context) => {
		var baseSpeed = ctx.baseSpeed;
                //Use baseSpeed here
	})

Set the crafting process base speed

Name : baseSpeed

Description :

Set a decimal value as the base speed (before upgrades are applied) of the crafting process.

The new speed must not be negative.

Note : This method won't work when used inside requireFunctionToStart, the other 3 function requirements are fine to use.

Example :

.requireFunctionOnStart((ctx as Context) => {
		ctx.baseSpeed = 2;
	})

Get the crafting process modified speed

Name : modifiedSpeed

Description :

Return a decimal value that represent the modified speed (after upgrades are applied) of the crafting process.

Note : This method won't work when used inside requireFunctionToStart, the other 3 function requirements are fine to use.

Example

.requireFunctionEachTick((ctx as Context) => {
		var modifiedSpeed = ctx.modifiedSpeed;
                //Use modifiedSpeed here
	})

Get the machine as a tile entity

Name : tile

Description :

Return a BlockEntity, you can use it to get various information about the machine, see the linked CT wiki page.

Example

.requireFunctionEachTick((ctx as Context) => {
		var tile = ctx.tile;
                //Use tile here
	})

Get the machine as a custom machine

Name : machine

Description :

Return a Machine, you can use it to check, input and output energy, fluids and items from/to the machine.

Example

.requireFunctionEachTick((ctx as Context) => {
		var machine = ctx.machine;
                //Use machine here
	})