Differences

This shows you the differences between two versions of the page.

--- scripting [2020/02/17 20:27] – [Event Scripting] mit
+++ scripting [2023/05/15 02:07] (current) – [Custom Events] mit
@@ Line 26: / Line 26: @@
 Event( "NewBuilding", "3" )
 {
-  *say %PLAYER% built building 3
+  *say %PLAYER% built building type 3
-  *grantitem %PLAYER% Special Item
+  *grantitem %PLAYER% 1 Special Item
 }
 </code>
-If you've already been playing around with owner features on your world, then the *commands might already be familiar - Just about anything you can do using the commands on the server you can do through the scripting system - which leads to lots of possible clever features done in script.
+If you've already been playing around with owner features on your world, then the *commands might already be familiar - Just about anything you can do using the commands on the server you can do through the scripting system - which gives the script system all the power you get as a world admin.
 For details on the range of events supported see the [[scripting:introduction_to_events|Event Scripting Overview]] and for a full list of the *commands see the [[Reference|reference section]].
 ===== Script Files =====
-The primary 'script' a server runs is stored in a file called ''Data\Scripts\ServerScript.mit'' - this is a text file that can contain commands and scripted events ( You can include other files (see [[scripting:other_language_features|#include]] docs) ). To change your script file, modify it in a text editor (or in the in-game editor when its finished) and then tell the server to reload it bt pressing F11 (or using the command ***reloadscript**).
+The primary 'script' a server runs is stored in a file called ''Data\Scripts\ServerScript.mit'' - this is a text file that can contain commands and scripted events ( You can include other files (see [[scripting:other_language_features|#include]] docs) ). To change your script file, modify it in a text editor (or in the in-game editor when its finished) and then tell the server to reload it by pressing F11 (or using the command ***reloadscript**).
 For a quick Hello World example.. Connect to your world, copy the code block below into your serverscript.mit, press f11 then type **&test**
@@ Line 50: / Line 50: @@
 The intention is that eventually the Script Editor in the F10 World Editor screens would provide that functionality however that is a long way from being complete or usable.
+===== Custom Events =====
+Custom Events are a special type of event that is triggered from a command and can include custom parameters.
+e.g. ''*event [Name] TestEvent|MyParam''
+will trigger an event specified in your script code like:
+<code>Event( "Custom", "TestEvent" )
+{
+   $text = $gTextParam[1]
+   *say Your Parameter was $text
+}</code>
+Custom events can be triggered for groups of players - e.g. for everyone online ('EventAllOnline'), or for everyone standing in a particular zone on the map.