Minecraft:Commands/scriptevent

Template:Distinguish Template:Exclusive Template:Infobox command Triggers a script event with an ID and message.

Syntax

scriptevent <messageId: string> <message: message>

Arguments

Must be a string. Must be namespaced and use of the minecraft namespace is invalid (e.g. Template:Command, Template:Cmd)

Optional argument. Maximum length is the C++ max string length. Template:Arg desc

Result

The command by itself does not directly affect anything in the game, but can trigger an event in any add-ons applied to the world/server.

Output

Command	Edition	Situation	Success Count
any	Minecraft:Bedrock Edition	On fail	0
		On success	1

Example

• To evoke an event handler with the ID wiki:example and the message "Example Message":
  • Template:Code
• Example JavaScript code for use in the scripting API:

<syntaxhighlight lang="javascript" line="1"> import { system } from "@minecraft/server";

system.afterEvents.scriptEventReceive.subscribe((event) => {

 const {
 	id,           // returns string (wiki:example)
 	initiator,    // returns Entity
   message,      // returns string (Example Message)
   sourceBlock,  // returns Block
   sourceEntity, // returns Entity
   sourceType,   // returns MessageSourceType
 } = event;

}); </syntaxhighlight>Code source

See also

• Template:Cmd— debugging options for GameTest Framework

External links

• Template:Cite