Minecraft:Commands/scriptevent: Difference between revisions
From SAS Gaming Wiki
More actions
Fix template calls: add MC/ prefix |
Sync: updated from Minecraft |
||
| Line 1: | Line 1: | ||
{{ | {{distinguish|Commands/script}} | ||
{{ | {{exclusive|bedrock|education}} | ||
{{Infobox command | {{Infobox command | ||
| name = scriptevent | | name = scriptevent | ||
| Line 6: | Line 6: | ||
| cheat = y | | cheat = y | ||
}} | }} | ||
Triggers a script event with an ID and message. | Triggers a [[Minecraft:Scripting|script]] event with an ID and message. | ||
==Syntax== | ==Syntax== | ||
| Line 12: | Line 12: | ||
==Arguments== | ==Arguments== | ||
{{ | {{argument|be=1|messageId: string|basic_string}} | ||
:Must be a string. Must be namespaced and use of the minecraft namespace is invalid (e.g. {{ | :Must be a string. Must be namespaced and use of the minecraft namespace is invalid (e.g. {{Command|scriptevent give:coal}}, {{Cmd|scriptevent my_scripts:spawn_sheep}}) | ||
{{ | {{argument|be=1|message: message|CommandMessage}} | ||
:Optional argument. Maximum length is the C++ max string length. {{ | :Optional argument. Maximum length is the C++ max string length. {{arg desc|be=CommandMessage}} | ||
==Result== | ==Result== | ||
| Line 24: | Line 24: | ||
{{Result table}} | {{Result table}} | ||
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. | The command by itself does not directly affect anything in the game, but can trigger an event in any [[Minecraft:add-ons]] applied to the world/server. | ||
==Output== | ==Output== | ||
| Line 45: | Line 45: | ||
*To evoke an event handler with the ID wiki:example and the message "Example Message": | *To evoke an event handler with the ID wiki:example and the message "Example Message": | ||
**{{ | **{{Code|code=/scriptevent wiki:example Example Message}} | ||
*Example JavaScript code for use in the scripting API: | *Example JavaScript code for use in the scripting API: | ||
<syntaxhighlight lang="javascript" line="1"> | <syntaxhighlight lang="javascript" line="1">import { system } from "@minecraft/server"; | ||
import { system } from "@minecraft/server"; | |||
system.afterEvents.scriptEventReceive.subscribe((event) => { | system.afterEvents.scriptEventReceive.subscribe((event) => { | ||
| Line 59: | Line 58: | ||
sourceType, // returns MessageSourceType | sourceType, // returns MessageSourceType | ||
} = event; | } = event; | ||
}); | });</syntaxhighlight>[https://wiki.bedrock.dev/scripting/script-server.html Code source] | ||
</syntaxhighlight>[https://wiki.bedrock.dev/scripting/script-server.html Code source] | |||
==History== | ==History== | ||
{{HistoryTable | {{HistoryTable | ||
|{{ | |{{HistoryLine|bedrock}} | ||
|{{HistoryLine||Beta APIs<br>(Experimental)|link=Bedrock Edition 1.19.60|dev=Preview 1.19.60.22|Added {{ | |{{HistoryLine||Beta APIs<br>(Experimental)|link=Bedrock Edition 1.19.60|dev=Preview 1.19.60.22|Added {{cmd|scriptevent|link=none}} behind the "Beta APIs" experimental toggle.}} | ||
|{{HistoryLine||1.20.30|dev=Preview 1.20.20.20|{{ | |{{HistoryLine||1.20.30|dev=Preview 1.20.20.20|{{cmd|scriptevent|link=none}} is no longer behind "Beta APIs" experimental toggle.}} | ||
}} | }} | ||
==See also== | ==See also== | ||
*{{ | *{{Cmd|script}}— debugging options for GameTest Framework | ||
== External links == | == External links == | ||
| Line 79: | Line 77: | ||
== Navigation == | == Navigation == | ||
{{ | {{Navbox commands}} | ||
de:Befehl/scriptevent | [[Minecraft:de:Befehl/scriptevent]] | ||
zh:命令/scriptevent | [[Minecraft:zh:命令/scriptevent]] | ||
Latest revision as of 11:03, 11 June 2026
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
Template:Result table Template:Result table Template:Result table Template:Result table
The command by itself does not directly affect anything in the game, but can trigger an event in any Minecraft: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":
- 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
History
See also
- Template:Cmd— debugging options for GameTest Framework