Package net.minecraft.server.function

Class CommandFunctionManager

java.lang.Object

net.minecraft.server.function.CommandFunctionManager

public class CommandFunctionManager
extends Object

The command function manager implements execution of functions, like that from the function command.

Mappings:

Namespace	Name
official	act
intermediary	net/minecraft/class_2991
named	net/minecraft/server/function/CommandFunctionManager

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommandFunctionManager.Entry
private class	CommandFunctionManager.Execution	An active execution of functions.
static interface	CommandFunctionManager.Tracer	A tree-visitor-like tracer, useful for gaining insights on function execution.

Field Summary

Fields

Modifier and Type	Field	Description
private @Nullable CommandFunctionManager.Execution	execution	The active execution within this manager.
private boolean	justLoaded	Whether this command function manager has just loaded and should run all functions in the minecraft:load function tag.
private static final Identifier	LOAD_TAG_ID
private FunctionLoader	loader	The source of functions for this command function manager.
private static final Text	NO_TRACE_IN_FUNCTION_TEXT	A localized piece of text indicating that calling the debug command to debug functions from within a function is not supported.
(package private) final MinecraftServer	server
private static final Identifier	TICK_TAG_ID
private List<CommandFunction>	tickFunctions	A list of minecraft:tick tag functions to run on every tick.

Constructor Summary

Constructors

Constructor	Description
CommandFunctionManager(MinecraftServer server, FunctionLoader loader)

Method Summary

Modifier and Type	Method	Description
int	execute(CommandFunction function, ServerCommandSource source)	Executes a function.
int	execute(CommandFunction function, ServerCommandSource source, @Nullable CommandFunctionManager.Tracer tracer)	Executes a function.
private void	executeAll(Collection<CommandFunction> functions, Identifier label)
Iterable<Identifier>	getAllFunctions()
com.mojang.brigadier.CommandDispatcher<ServerCommandSource>	getDispatcher()
Optional<CommandFunction>	getFunction(Identifier id)
Iterable<Identifier>	getFunctionTags()
int	getMaxCommandChainLength()
ServerCommandSource	getScheduledCommandSource()	Returns the command source to execute scheduled functions.
Collection<CommandFunction>	getTag(Identifier id)
private void	load(FunctionLoader loader)
void	setFunctions(FunctionLoader loader)	Sets the functions that this command function manager will use in executions.
void	tick()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NO_TRACE_IN_FUNCTION_TEXT

private static final Text NO_TRACE_IN_FUNCTION_TEXT

A localized piece of text indicating that calling the debug command to debug functions from within a function is not supported.

Mappings:

Namespace	Name	Mixin selector
official	a	Lact;a:Lss;
intermediary	field_33542	Lnet/minecraft/class_2991;field_33542:Lnet/minecraft/class_2561;
named	NO_TRACE_IN_FUNCTION_TEXT	Lnet/minecraft/server/function/CommandFunctionManager;NO_TRACE_IN_FUNCTION_TEXT:Lnet/minecraft/text/Text;

TICK_TAG_ID

private static final Identifier TICK_TAG_ID

Mappings:

Namespace	Name	Mixin selector
official	b	Lact;b:Lacf;
intermediary	field_13417	Lnet/minecraft/class_2991;field_13417:Lnet/minecraft/class_2960;
named	TICK_TAG_ID	Lnet/minecraft/server/function/CommandFunctionManager;TICK_TAG_ID:Lnet/minecraft/util/Identifier;

LOAD_TAG_ID

private static final Identifier LOAD_TAG_ID

Mappings:

Namespace	Name	Mixin selector
official	c	Lact;c:Lacf;
intermediary	field_13412	Lnet/minecraft/class_2991;field_13412:Lnet/minecraft/class_2960;
named	LOAD_TAG_ID	Lnet/minecraft/server/function/CommandFunctionManager;LOAD_TAG_ID:Lnet/minecraft/util/Identifier;

server

final MinecraftServer server

Mappings:

Namespace	Name	Mixin selector
official	d	Lact;d:Lnet/minecraft/server/MinecraftServer;
intermediary	field_13419	Lnet/minecraft/class_2991;field_13419:Lnet/minecraft/server/MinecraftServer;
named	server	Lnet/minecraft/server/function/CommandFunctionManager;server:Lnet/minecraft/server/MinecraftServer;

execution

@Nullable
private @Nullable CommandFunctionManager.Execution execution

The active execution within this manager.

Mappings:

Namespace	Name	Mixin selector
official	e	Lact;e:Lact$a;
intermediary	field_33543	Lnet/minecraft/class_2991;field_33543:Lnet/minecraft/class_2991$class_6345;
named	execution	Lnet/minecraft/server/function/CommandFunctionManager;execution:Lnet/minecraft/server/function/CommandFunctionManager$Execution;

tickFunctions

private List<CommandFunction> tickFunctions

A list of minecraft:tick tag functions to run on every tick. Set up on load, this is more efficient than polling the tag from the loader every tick.

Mappings:

Namespace	Name	Mixin selector
official	f	Lact;f:Ljava/util/List;
intermediary	field_13418	Lnet/minecraft/class_2991;field_13418:Ljava/util/List;
named	tickFunctions	Lnet/minecraft/server/function/CommandFunctionManager;tickFunctions:Ljava/util/List;

justLoaded

private boolean justLoaded

Whether this command function manager has just loaded and should run all functions in the minecraft:load function tag.

Mappings:

Namespace	Name	Mixin selector
official	g	Lact;g:Z
intermediary	field_13422	Lnet/minecraft/class_2991;field_13422:Z
named	justLoaded	Lnet/minecraft/server/function/CommandFunctionManager;justLoaded:Z

loader

private FunctionLoader loader

The source of functions for this command function manager.

Mappings:

Namespace	Name	Mixin selector
official	h	Lact;h:Lacs;
intermediary	field_25333	Lnet/minecraft/class_2991;field_25333:Lnet/minecraft/class_5349;
named	loader	Lnet/minecraft/server/function/CommandFunctionManager;loader:Lnet/minecraft/server/function/FunctionLoader;

Constructor Details

CommandFunctionManager

public CommandFunctionManager(MinecraftServer server,
 FunctionLoader loader)

Mappings:

Namespace	Name	Mixin selector
official	<init>	Lact;<init>(Lnet/minecraft/server/MinecraftServer;Lacs;)V
intermediary	<init>	Lnet/minecraft/class_2991;<init>(Lnet/minecraft/server/MinecraftServer;Lnet/minecraft/class_5349;)V
named	<init>	Lnet/minecraft/server/function/CommandFunctionManager;<init>(Lnet/minecraft/server/MinecraftServer;Lnet/minecraft/server/function/FunctionLoader;)V

Method Details

getMaxCommandChainLength

public int getMaxCommandChainLength()

Mappings:

Namespace	Name	Mixin selector
official	a	Lact;a()I
intermediary	method_12902	Lnet/minecraft/class_2991;method_12902()I
named	getMaxCommandChainLength	Lnet/minecraft/server/function/CommandFunctionManager;getMaxCommandChainLength()I

getDispatcher

public com.mojang.brigadier.CommandDispatcher<ServerCommandSource> getDispatcher()

Mappings:

Namespace	Name	Mixin selector
official	b	Lact;b()Lcom/mojang/brigadier/CommandDispatcher;
intermediary	method_12900	Lnet/minecraft/class_2991;method_12900()Lcom/mojang/brigadier/CommandDispatcher;
named	getDispatcher	Lnet/minecraft/server/function/CommandFunctionManager;getDispatcher()Lcom/mojang/brigadier/CommandDispatcher;

tick

public void tick()

Mappings:

Namespace	Name	Mixin selector
official	c	Lact;c()V
intermediary	method_18699	Lnet/minecraft/class_2991;method_18699()V
named	tick	Lnet/minecraft/server/function/CommandFunctionManager;tick()V

executeAll

private void executeAll(Collection<CommandFunction> functions,
 Identifier label)

Mappings:

Namespace	Name	Mixin selector
official	a	Lact;a(Ljava/util/Collection;Lacf;)V
intermediary	method_29460	Lnet/minecraft/class_2991;method_29460(Ljava/util/Collection;Lnet/minecraft/class_2960;)V
named	executeAll	Lnet/minecraft/server/function/CommandFunctionManager;executeAll(Ljava/util/Collection;Lnet/minecraft/util/Identifier;)V

execute

public int execute(CommandFunction function,
 ServerCommandSource source)

Executes a function.

This is same as calling execute(function, source, null).

Parameters:

function - the function

source - the command source to execute with

Returns:

the command output value

See Also:

• execute(CommandFunction, ServerCommandSource, Tracer)

Mappings:

Namespace	Name	Mixin selector
official	a	Lact;a(Ldj;Ldn;)I
intermediary	method_12904	Lnet/minecraft/class_2991;method_12904(Lnet/minecraft/class_2158;Lnet/minecraft/class_2168;)I
named	execute	Lnet/minecraft/server/function/CommandFunctionManager;execute(Lnet/minecraft/server/function/CommandFunction;Lnet/minecraft/server/command/ServerCommandSource;)I

execute

public int execute(CommandFunction function,
 ServerCommandSource source,
 @Nullable
 @Nullable CommandFunctionManager.Tracer tracer)

Executes a function. This may have two cases: new or recursive.

In a new execution, the execution == null, and a custom tracer can be specified. The return value indicates the number of commands and nested functions ran.

In a recursive execution, execution != null. It is required that tracer == null, or the execution reports an error and is skipped. The return value is 0.

Parameters:

function - the function

source - the command source to execute with

tracer - a tracer for a non-recursive function execution

Returns:

a non-zero value for a new execution, or 0 for a recursive execution

See Also:

• execute(CommandFunction, ServerCommandSource)

Mappings:

Namespace	Name	Mixin selector
official	a	Lact;a(Ldj;Ldn;Lact$c;)I
intermediary	method_36341	Lnet/minecraft/class_2991;method_36341(Lnet/minecraft/class_2158;Lnet/minecraft/class_2168;Lnet/minecraft/class_2991$class_6346;)I
named	execute	Lnet/minecraft/server/function/CommandFunctionManager;execute(Lnet/minecraft/server/function/CommandFunction;Lnet/minecraft/server/command/ServerCommandSource;Lnet/minecraft/server/function/CommandFunctionManager$Tracer;)I

setFunctions

public void setFunctions(FunctionLoader loader)

Sets the functions that this command function manager will use in executions.

Parameters:

loader - the new loader functions will be taken from

Mappings:

Namespace	Name	Mixin selector
official	a	Lact;a(Lacs;)V
intermediary	method_29461	Lnet/minecraft/class_2991;method_29461(Lnet/minecraft/class_5349;)V
named	setFunctions	Lnet/minecraft/server/function/CommandFunctionManager;setFunctions(Lnet/minecraft/server/function/FunctionLoader;)V

load

private void load(FunctionLoader loader)

Mappings:

Namespace	Name	Mixin selector
official	b	Lact;b(Lacs;)V
intermediary	method_29773	Lnet/minecraft/class_2991;method_29773(Lnet/minecraft/class_5349;)V
named	load	Lnet/minecraft/server/function/CommandFunctionManager;load(Lnet/minecraft/server/function/FunctionLoader;)V

getScheduledCommandSource

public ServerCommandSource getScheduledCommandSource()

Returns the command source to execute scheduled functions. Scheduled functions are those from the /schedule command and those from the minecraft:tick tag.

This command source has permission level 2 and is silent compared to the server's command source.

Returns:

the command source to execute scheduled functions

Mappings:

Namespace	Name	Mixin selector
official	d	Lact;d()Ldn;
intermediary	method_12899	Lnet/minecraft/class_2991;method_12899()Lnet/minecraft/class_2168;
named	getScheduledCommandSource	Lnet/minecraft/server/function/CommandFunctionManager;getScheduledCommandSource()Lnet/minecraft/server/command/ServerCommandSource;

getFunction

public Optional<CommandFunction> getFunction(Identifier id)

Mappings:

Namespace	Name	Mixin selector
official	a	Lact;a(Lacf;)Ljava/util/Optional;
intermediary	method_12905	Lnet/minecraft/class_2991;method_12905(Lnet/minecraft/class_2960;)Ljava/util/Optional;
named	getFunction	Lnet/minecraft/server/function/CommandFunctionManager;getFunction(Lnet/minecraft/util/Identifier;)Ljava/util/Optional;

getTag

public Collection<CommandFunction> getTag(Identifier id)

Mappings:

Namespace	Name	Mixin selector
official	b	Lact;b(Lacf;)Ljava/util/Collection;
intermediary	method_29462	Lnet/minecraft/class_2991;method_29462(Lnet/minecraft/class_2960;)Ljava/util/Collection;
named	getTag	Lnet/minecraft/server/function/CommandFunctionManager;getTag(Lnet/minecraft/util/Identifier;)Ljava/util/Collection;

getAllFunctions

public Iterable<Identifier> getAllFunctions()

Mappings:

Namespace	Name	Mixin selector
official	e	Lact;e()Ljava/lang/Iterable;
intermediary	method_29463	Lnet/minecraft/class_2991;method_29463()Ljava/lang/Iterable;
named	getAllFunctions	Lnet/minecraft/server/function/CommandFunctionManager;getAllFunctions()Ljava/lang/Iterable;

getFunctionTags

public Iterable<Identifier> getFunctionTags()

Mappings:

Namespace	Name	Mixin selector
official	f	Lact;f()Ljava/lang/Iterable;
intermediary	method_29464	Lnet/minecraft/class_2991;method_29464()Ljava/lang/Iterable;
named	getFunctionTags	Lnet/minecraft/server/function/CommandFunctionManager;getFunctionTags()Ljava/lang/Iterable;