/function

{
    "title": "<code>/function</code>",
    "rows": [
        {
            "field": "\n* 2 ‌<sup class=\"noprint nowrap Inline-Template \" title=\"\">[<i><span title=\"This statement only applies to Java Edition\">(link to Java Edition article, displayed as JE)  only</span></i>]</sup>\n* 1 ‌<sup class=\"noprint nowrap Inline-Template \" title=\"\">[<i><span title=\"This statement only applies to Bedrock Edition\">(link to Bedrock Edition article, displayed as BE)  only</span></i>]</sup>",
            "label": "(link to Permission level article, displayed as Permission level<br>required)"
        },
        {
            "field": "(link to Options article, displayed as Cheat) only‌<sup class=\"noprint nowrap Inline-Template \" title=\"\">[<i><span title=\"This statement only applies to Bedrock Edition\">(link to Bedrock Edition article, displayed as BE)  only</span></i>]</sup>",
            "label": "(link to Commands#Restrictions article, displayed as Restrictions)"
        }
    ],
    "invimages": [],
    "images": []
}

Runs commands found in the corresponding function file(s) with command execution context (executor, execution position, angles, etc) of the /function command itself.

Usage

In Java Edition, runs a function or all functions in a tag from a data pack.

In Bedrock Edition, runs a function from a behavior pack.

In Java Edition, the behavior of /return run function ... (or /return run execute ... run function ...) is different with a direct call to the /function command. If /return run function ... runs multiple functions, execution stops after first /return in any of the functions. If a direct call to the /function ... runs multiple functions, all of the functions are executed, and the return values are added up as the result value of the /function ... command.

Syntax

• Java Edition

function <name>

Runs a function or functions in a tag.

function <name> <arguments>

function <name> with (block <sourcePos>|entity <source>|storage <source>) [<path>]

Runs a function or functions in a tag, with arguments for macros.

• Bedrock Edition

function <name: filepath>

Runs a function.

Arguments

JE: <name>: function
BE: name: filepath: CommandFilePath

Specifies the function(s) to execute.

In Java Edition, must be a resource location or one prefixed with a #, which resolves into a function or a function tag during command execution. In Bedrock Edition, must be of the format path/to/function/file, which resolves into a function located at [behavior_pack]/functions/path/to/function/file.mcfunction during command execution.

JE: <arguments>: nbt_compound_tag

Specifies arguments for macro functions in a compound NBT tag.

Must be a [NBT Compound / JSON Object] compound NBT in SNBT format.

JE: <sourcePos>: block_pos

The position of the target block entity whose NBT is to be used.

Must be a block position composed of <X>, <Y> and <Z>, each of which must be an integer or a tilde and caret notation.

JE: <source>: entity (in entity <target> mode)

Specifies an entity whose NBT is to be used.

Must be a player name, a target selector or a UUID.

JE: <source>: resource_location (in storage <target> mode)

Specifies a storage whose NBT is to be used.

Must be a resource location for an unregistered content.

JE: <path>: nbt_path

Specifies the NBT path. Should be a path of a single compound tag.

Must be an NBT path.

Result

Output

In Java Edition, for /return run execute store ... run function ...:

In Java Edition, otherwise:

In Bedrock Edition:

Examples

• In Java Edition:
  • To run a function located at data/custom/functions/example/test.mcfunction in a loaded data pack: /function custom:example/test
  • To run all functions in a function tag located at data/custom/tags/functions/example/test.json: /function #custom:example/test
  • To run a function if there is a sheep within a radius of 2 blocks: /execute if entity @e[type=sheep,distance=..2] run function custom:example/test
  • To run a function unless the executor is a player: /execute unless entity @s[type=player] run function custom:example/test
  • To run a function macro with arguments a=42, b="example": /function custom:example/test {a: 42, b: "example"}
  • To run a function macro with arguments from storage custom:storage: /function custom:example/test with custom:storage

History

See also

• Tag – To run function in batch, every tick, or on server (re)load.

References

Navigation