The Universal World Owner's Manual

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== 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' )
  * All variables are preceeded with $

===== Conditional Statements =====
''if'', ''else'' and ''else if'' are supported, for example...
<code>
	if ( $itemNum = 112 )	
	{
	    *grantskill %PLAYER% Blacksmith
	}
	else if ( $itemNum = 113 )
	{
	    *grantskill %PLAYER% Scientist
	}
	else 
	{
	    *msg %PLAYER% You didnt learn anything new today
	}
</code>

Supported conditions inside an ''if'' or ''else if'' are:
  * ''=''  (or ''=='' ) 
  * ''<''
  * ''>'' 
  * ''!=''   (or ''<>'' ) 
  * ''<=''  ('' < = '' )  
  * ''>=''

===== Loops =====
''while'' loops are supported, for example...
<code>
$loop = 0
while ( $loop < 10 )
{
   DoMyFunction( $loop )
   $loop += 1
}
</code>

===== Comments =====

Code comments are simple C-stylee, e.g 
<code>
    // Check the item number
    if ( $itemNum = 112 )	
    {
//      *say Nothing (this line is commented out)
    }
</code>

===== Maths operators =====

Basic maths operators are supported in simple form. Compound operations are not yet supported so each line needs to be kept to a single operation, e.g. :

<code>
     $var = 1
     $newvar = $var * 100
     $var += 1
</code>

Currently the 4 basic operators ( ''+, -, /, *'' ) are supported, along with ( ''+=, -=, /=, *='' ) for operating on the LHS variable (e.g. ''$var += 1'' is equivalent to ''$var = $var + 1''.

===== Local, Module & Global Variables =====

Local variables can be used at any point without advance declaration. They remain in scope throughout the event or function as you'd expect. 
Module variables (those that are instantiated outside of an event or function) remain in scope for all events and functions within the file until the script is reloaded or the server is restarted.
Global variables are declared using the keyword 'global' and are available to all functions and events in any file.

Example Local variable use :
<code>
Event( "UseItem", "Bongos" )
{
   $myage = $gPlayerAge / 10
   if ( $myage = 6 )
   {
      *say I'm in my sixties and im still playing the bongos
   }
}
</code>
Example module variable use :
<code>
$mNumberOfBongoPlays = 0
Event( "UseItem", "Bongos" )
{
   $mNumberOfBongoPlays = $mNumberOfBongoPlays + 1
   *say $mNumberOfBongoPlays people have played the bongos since the script was last restarted
}
</code>
Example global variable use :
<code>
global $kNumberOfBongoPlays = 0
Event( "UseItem", "Bongos" )
{
   $kNumberOfBongoPlays = $kNumberOfBongoPlays + 1
   *say $kNumberOfBongoPlays people have played the bongos since the script was last restarted
}
</code>

===== Arrays =====

Local, module and global arrays can be created. Arrays can contain values and text. Array indexing starts from 1, which is a bit annoying if you've got any sense at all but hey ho.

Arrays are declared and referenced as shown :

<code>
$maTestArray[] = 
{
    100,   "Item 1",
    200,   "Item 2", 
}

Event( "&command", "TestArray" )
{
   *say The first value in the array is $maTestArray[1]
   *say The second text item in the array is $maTestArray[4] 
}
</code>

.. which would print 'The first value in the array is 100' followed by 'The second text item in the array is Item 2'.


* [[Scripting:Other Language Features|Other Important Language Features]]