Universal World Owners Manual - scripting

basic_syntax

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:56+00:00

Script Language Syntax The scripting language supports a limited range of the basic syntactical components that make up most similar-level programming languages General Rules * Each line of script needs to be put on a new line * All script code is case-insensitive. (e.g. the variable 'a' is the same as the variable 'A' )

cutscenes

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:56+00:00

Cutscenes Overview You can trigger a cutscene for someone from script or manually using the command : *cutscene [PLAYERNAME] [CUTSCENE_FILENAME] The cutscene is contained within a file on the server that the client will download. Cutscenes allow you to control the camera and player, add models and graphics, add UI text and do things like play music and control special effects.

events_reference

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:56+00:00

Events Reference Here is a list of all the events currently supported by the world server Player Status Events NewPlayer PlayerLogin PlayerLogout PlayerBirthday PlayerDeath PlayerKilled RobocrowKilled RobocrowKill PlayerRespawn

functions_custom_events_overview

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:56+00:00

Functions Functions are defined in your script as shown in this example: Function IsItemASword( $itemNum ) { if ( $itemNum = 112 ) // Sword { return( 1 ) } else if ( $itemNum = 113 ) // Sword 2 { return( 1 ) } return( 0 ) }

functions

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:56+00:00

includes

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:56+00:00

Includes Rather than having all of your script code in the one 'ServerScript.mit' file, it is expected that you will split your script across multiple files, with each file usually relating to one area of your game-world. (e.g. You may have a file to handle all the usable items on your world, or one for handling a particular cutscene or scripted building).

introduction_to_events

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:56+00:00

Event Scripting Overview Events are triggered on your world server when various things happen - for instance, a 'UseItem' event is triggered when a player uses an item - and you add script for each event - for instance, adding a particle effect and changing a score whenever a particular item is used. You control events on your world server by script through the file

introduction

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:56+00:00

Introduction to World Scripting The Universal allows world owners to control much of the game via script. Using the custom scripting language you can create new behaviours for items and scenes on your world. Although the scripting language is fairly simple, you will require some knowledge of programming to understand and make the most of the features on offer. This section of the manual covers most of the basics about writing scripts - to really find out what you can do with it, you'll just nee…

other_language_features

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:57+00:00

reference

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:57+00:00

Scripting Reference This section provides detailed lists and explanations of the functionality provided by the scripting system(s). See the Scripting Overview for an introduction to the scripting language and its uses. * Events Reference * System Values * System Functions * Scripted OSD Reference * Scripted Entities Reference * Cutscenes Reference * Command Reference Index

samples

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:57+00:00

Script Samples Possibly the best place to find script samples is to create a local world, pick one of the templates provided then examine the scripts that make up the template. (You can look at the scripts in the F10 -> Script Editor in game, or browse to your LocalWorlds folder which will be in C:\Users\[UserName]\AppData\Local\Games For May\The Universal\ by default). By editing those template scripts and reloading them while in game (press F11 or use *reloadscript) you can immediately see ho…

scriptedosd

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:57+00:00

Scripted OSD Overview The ScriptedOSD system allows you to write scripts on your server that can bring up a window on the client, displaying images, text, buttons etc, which the player is able to interact with. For details of all the OSD commands and parameters available see the

setting_up_visual_studio

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T18:58:06+00:00

Setting Up Visual Studio to manage your Script Files Microsoft provide a free IDE called Visual Studio Community : Although intended for full application development, it offers some features that make it useful for developing scripts in the game. If thats all you want it for, don't bother adding any of the extra 'workload' features and then its not too big of a download.

subgames

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T18:58:06+00:00

Scripted Subgames Overview The 'Subgames' system provides your script with a set of functions that allows dynamic creation, monitoring and conclusion of multiplayer subgames. The basic process is : - Create a Subgame and join players to it - Start the Subgame (perhaps moving players to a new location, starting timers, etc) - Update the game and wait for end-game criteria to be me - Finish the subgame (perhaps rewarding victorious players before returning them to their original location)

syntax

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:57+00:00

system_functions

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:57+00:00

System Functions “Rand”, SF_RAND e.g. $var = Rand(500) Returns a random number between 1 and the value specified “PlayerSkillLevel”, SF_PLAYERSKILLLEVEL e.g $var = PlayerSkillLevel(“Farmer”) Returns the current player's skill level for the skill named

system_values_functions_overview

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:57+00:00

System Values 'System Values' are special read-only, global variables that provide information about the state of the current player and the world. e.g. $gPlayerAge tells you the age of the current player. Here's a quick example of how you might use that

system_values

Anonymous (anonymous@undisclosed.example.com) — 2025-05-28T16:34:57+00:00