NT Script

From FTL13
Jump to navigation Jump to search
This page needs revising!

The following page is out of date and/or needs to be revised. If the page's guide needs revision, see here for an example.
The revision reason is: "Scripts have currently been removed from the game due to PR #12105 as of 4 of october of 2015."



The NT Scripting Language(NT Script, or NTSL) is a new piece of technology being pushed by NT Tech Department to standardize programming and communication of all Nanotrasen-grade electronic devices. Its syntax is a mixture of PHP, C++, and JavaScript. Most implementations of NT Script are not object-oriented and do not allow the definition of classes, instead, rely on ROBUST(tm) memory management system to store entities in a dynamic data tree. NT Script does allow the in-line definition of functions, however.

It is important to note that NT Scripting should not be treated as BYOND coding. NT Scripting handles some things differently than BYOND does.

A repository for scripts can be found here.

Simple Guide to Using Scripts

  1. Get to the Telecommunications Control Room
  2. Open up the Telecommunications Traffic Control Console
  3. Authorize yourself access by clicking on Insert ID while holding your ID
  4. [Scan] for servers
  5. Click on a server which radio channel you wish to alter
  6. [Edit Code] to see the server's code
  7. Type your code into the window
  8. Press Compile
  9. Close the code window
  10. Change Signal Execution to ALWAYS
  11. Congratulations, you're done!
    • Repeat steps 5 to 10 for each desired channel

Syntax Guide

NT Script follows a simple-to-use syntax designed for users of all levels of programming expertise. Whitespace is ignored, semicolon break points are required, and curly brackets are required.


Variables

Variables are used to temporarily store any form of data that can be accessed somewhere else in the code. For simplicity, we'll ignore the fact that you can only use variables in children scope. Here is how you create a variable: 

$myVariable = 5; // The $ indicates that it is a variable.

You can alternatively assign the same variable a text value, or a string. 

$myVariable = "Hello world!";


Functions

Functions can be used and defined dynamically. There are different pre-defined functions for each NTSL implementation, however the basic ones will remain the same. Here is how you use a function: 


$myVariable = getNumber();

In this example, $myVariable is assigned whatever value getNumber() returns. Each function returns a value, even if a value return is explicitly not defined. Here are some more examples of how to use functions: 

broadcast($myVariable);
broadcast("Hello world!");
broadcast("Griffing assistants in T-minus " + $myVariable + " seconds.");


You can also define your own functions, using the def keyword. 

def getNumber() {
    return 5;
}


Code Blocks

Blocks of code are called when a specific piece of code signals that it is a representation of a block of code. Variables defined in one code block cannot be applied or changed in other nonrelated code blocks; this is known as scope. For example: 

$myGlobalVariable = getNumber();

while($myGlobalVariable != 0) {
    
   $myLocalVariable = 0;
   $myGlobalVariable = $myLocalVariable;
}

$myLocalVariable = 50; // this is invalid; myLocalVariable does not exist in this scope

Once the interpreter reads the closing bracket, it destroys all variable definitions within the scope, therefore you cannot use any of the variables that existed in that particular block of code.


Conditionals

The while() loop in the previous example is considered a conditional because it only continues executing when the condition between the parentheses is true. The != is known as a relational operator which returns true to the interpreter if myGlobalVariable does not equal 0. It can be read as "while myGlobalVariable does not equal 0, execute the following block of code".

Here is a list of all relational operators:


== : Equals
!=  : Does not equal
<  : Less than
>  : Greater than
<= : Less than or equal to
>= : Greater than or equal to


Relational operators can be used in if(), and elseif(), statements, which are used the following way: 

if($myVariableNumber == 50) // if my number is 50
{
   // code block
}
elseif($myVariableNumber <= 30) // if not, is my number 30 or less?
{   
   // code block
}
else // if not either 50 OR 30 or more, do this instead
{
   // code block
}

Math

The math operators are for the most part pretty standard, the only one to watch out for is division which is not the expected / (as that would clash with comments in the naive ntsl parser) 

* is multiplication

+ is addition

- is subtraction

/ is division

^ is exponentiation

NT Deluxe Namespaces

Nanotrasen will constantly add new universal functions and features to NTSL, here are a few of them:


Number

Syntax Returns Description
prob(number) number Returns nonzero is the probability succeeded. Returns zero if the probability failed.
sqrt(number) number Returns the square root of Arg.1.
abs(number) number Returns the magnitude of Arg.1.
floor(number) number Returns the Arg.1 rounded down to nearest integer.
ceil(number) number Returns the Arg.1 rounded up to nearest integer.
round(number) number Returns the Arg.1 rounded to nearest integer. 1.5 becomes 2, 1.49 becomes 1.
clamp(number, number, number) number Clamps Arg.1 between min(Arg.2) and max(Arg.3). clamp(30, -30, 25) = 25
inrange(number, number, number) number Returns 1 if Arg.1 is inbetween min(Arg.2) and max(Arg.3).
min(...) number Returns the smallest value of all arguments.
max(...) number Returns the largest value of all arguments.
tostring(number) string Returns a sting value of the number.
rand(number, number) number Returns a random integer that is inbetween min(Arg.1) and max(Arg.2).
rand(number) number Returns a random integer that is inbetween 0 and max(Arg.1).
rand() number Returns a random float that is inbetween 0 and 1.
randseed(number) Resets the RNG with this value.
sin(value) number Returns the sine of the value.
cos(value) number Returns the cosine of the value.
asin(value) number Returns the arcsine of the value.
acos(value) number Returns the arcossine of the value.
log(value) number Returns the logarithm of the value.

String

A string is a sequence of characters. A string is defined by two quote marks.
"Hello world!" is a string.
A strings length is the amount of letters and blankspaces it contains.

Syntax Returns Description
find(string, string) number Returns the position of the first occurrence of Arg.2 in Arg.1 or 0 if no matches were found.
length(string) number Returns the length of the string.
substr(string, number, number) string Returns a substring from Arg.1 based on start (Arg.2) to end (Arg.3).
replace(string, string, string) string Returns a instance of the string (Arg.1) where all occurences of Arg.2 are replaced by Arg.3.
lower(string) string Converts the string to lowercase.
upper(string) string Converts the string to uppercase.
proper(string) string Converts the first character to uppercase, rest to lowercase.
explode(string, string) vector This will split the string(Arg.1) at every place that matches the separator(Arg.2) in to a vector. explode("Hello there young friend", " "), will produce a vector with 4 indices, "Hello", "there", "young", "friend". This is very useful for chat commands: if(at(explode($content, " "),1)=="/bot"){dostuff} will make dostuff only run if the first word was /bot.
repeat(string, number) string Repeats the string n(Arg.2) amount of times.
reverse(string) string Reverses the string.
tonum(string) number Converts the string in to a number.

Vector

Vectors are resizeable data containers for storing any form of entities inside. They are very useful for serving as lists; their members can be instantly accessed provided you have an appropriate position. People call them arrays in other languages. Vector indexes in NTSL start at 1, unlike in other languages where arrays are usually zero-indexed.

Syntax Returns Description
vector(...) vector Returns a vector with a given number of entities. You can add an infinite number of entries, or no entries at all.
at(vector, number, var) var Sets the cell at Arg.2 index in the Arg.1 vector to Arg.3 if Arg.3 is supplied, otherwise, returns the value located at Arg.2.
copy(vector, number, number) vector Returns a new vector based on Arg.1, ranging from minimum index Arg.2 to Arg.3.
push_back(vector, ...) Adds Arg.2 (and every item after) to the end of the vector. Deprecated by the += operator.
remove(vector, ...) Loops through the vector and deletes the items matching the Args.
cut(vector, number, number) Cuts out entries from Arg.2 to Arg.3 in the Arg.1 vector.
swap(vector, number, number) Swaps the entries's position at Arg.2 and Arg.3 in the Arg.1 vector.
insert(vector, number, var) Inserts Arg.3 into Arg.1 at index Arg.2.
find(vector, var) var Searches the Arg.1 vector for Arg.2, returns 0 if not found.
length(vector) number Returns the length of the vector. (amount of indices)
implode(vector, string) string This will join the vector(Arg.1) in a string separating the indices with the separator(Arg.2) and returns that string.

Miscellaneous Definitions

Syntax Returns Description
pick(...) var Returns a randomly-selected entry from the parameters. Note: vector parameters will add their entries into the "raffle". The function will never return a vector.
time() number Returns the real time of the server in a number. You can then use this to see how much time has passed since the code has last been run via mem().
timestamp(format) string Returns a string of the time, formatted by the parameter. E.g: "DDD MMM DD hh:mm:ss YYYY" or "hh:mm:ss" or "DD MM YY".

Prefab Variables

PI = 3.141592653;
E = 2.718281828;
SQURT2 = 1.414213562;
FALSE = 0; // true/false are just Boolean shortcuts to 0 and 1
TRUE = 1;
NORTH = 1;
SOUTH = 2;
EAST = 4;
WEST = 8;

$common = 1459
$science = 1351
$command = 1353
$medical = 1355
$engineering = 1357
$security = 1359
$supply = 1347

HUMAN = 1
MONKEY = 2
ALIEN = 4
ROBOT = 8
SLIME = 16
DRONE = 32
 
$robot = "robot"
$loud = "yell"
$emphasis = "italics"
$wacky = "sans"

Traffic Control Systems Implementation

The Telecommunications system is directly tied to the TCS scripting implementation. It comes with the following functions and features.


Realtime signal modification

If the code is set to execute automatically, signals will first execute stored server code. Signal information is stored in the following variables: 

$source   // the source of the signal
$content  // the content of the signal
$freq     // the frequency of the signal
$pass     // determines if the signal will be broadcasted
$job      // the job (only for radio messages) of the operator
$language // the language of the signal. Can be any of HUMAN, MONKEY, ALIEN, ROBOT, SLIME or DRONE. Or a combination of them
$filters  // The voice filter of the signal. Includes bolding, italics, as well as silicon and wacky fonts. These must be given as a vector!
$say      // The verb used in a radio messages ending in "."
$ask	   // The verb used in messages ending in "?". Example: COMMON SERVER asks, "Why?"
$exclaim  // The verb used in a radio messages ending in "!" Note that having more exclamation points changes it to "$yell".
$yell	   // The verb used in a radio messages ending in "!!" or more exclamation points. By default, these messages are bolded.

Functions

TCS also comes with the following functions (parameters may be ignored for automatic assignment):


broadcast()

broadcast(message, frequency, source, job)

Sends a radio signal to neighboring subspace broadcasters to broadcast with the following parameters.

message: The radio message
frequency: The frequency to broadcast to
source: The name of the broadcaster. If the source name is not in a server-side voice databank (voice analysis is performed every time a person speaks over a channel) the name will appear in UPPERCASE and Italicized to indicate a synthesized voice job
job: The job of the orator.

Examples: 

broadcast("Hello world!");

defaults:
frequency: 1459
source: the server name
job: None 

broadcast("HELP GRIEFF", 1459, "Burer", "Security Officer");

signal()

signal(frequency, code)

Sends a signal to the frequency, with the code. This works exactly like a remote signaler.

frequency: The frequency to send to.
code: The code to attach to the signal.

Examples: 

signal(1359, 25);

defaults:
frequency: 1459
code: 30

mem()

mem(key, value)

Variables declared in a script expire after the script has finished executing (duh). The mem function allows you to save persistent information to the server's memory to be retrieved by future executions of the script. Each telecommunications server contains its own separate databank, which is basically a hash table/dictionary, a data structure consisting of a set of key-value pairs. When called with just the key as an argument, mem will return the associated value. When called with two arguments, mem will set the value associated with the key.

key: A string used to identify the variable to be saved.
value: The information you want to store for future use. Can be any type.

Examples: 

$source = "Jarsh Mellow";
mem($source + "'s Mom");  // returns the value associated with the key "Jarsh Mellow's Mom". Returns null/0 if not found
mem($source + "'s Mom", "Lindsay Donk"); // sets the value associated with the key "Jarsh Mellow's Mom" to "Lindsay Donk".

Examples

Here are a few examples. You can find more useful snippets here.

Chat calculator

A simple chat calculator.
Type "/calc 1+1" in chat and watch the magic happen. NB: division is not implemented due to budget cuts. 

$expld1 = explode($content, " ");
if(at($expld1, 1) ==  "/calc")
{
	$s = at($expld1, 2);
	$found = 0;
	if(find($s, "+") && $found == 0)
	{
		$expld2 = explode($s, "+");
		broadcast($s + " = " + tostring(tonum(at($expld2,1)) + tonum(at($expld2,2))), $freq, "LINDSAY", "CALCULATER");
		$found = 1;
	}
	if(find($s, "-") && $found == 0)
	{
		$expld2 = explode($s, "-");
		broadcast($s + " = " + tostring(tonum(at($expld2,1)) - tonum(at($expld2,2))), $freq, "LINDSAY", "CALCULATER");
		$found = 1;
	}
	if(find($s, "*") && $found == 0)
	{
		$expld2 = explode($s, "*");
		broadcast($s + " = " + tostring(tonum(at($expld2,1)) * tonum(at($expld2,2))), $freq, "LINDSAY", "CALCULATER");
		$found = 1;
	}
}
$pass = 1;

Magic 8-Ball

A simple Magic 8-Ball that will answer anyone's question.
Type in "/8ball <your question>" and you will get a magical response! 

$explodeString = explode($content, " ");
if(at($explodeString, 1) ==  "/8ball")
{
	//By Giacomand
	$pass = 0;
	$8ball = pick("It is certain", "It is decidedly so", "Without a doubt", "Yes – definitely",
	"You may rely on it", "As I see it, yes", "Most likely", "Outlook good", "Yes", "Signs point to yes",
	"Reply hazy, try again","Ask again later","Better not tell you now","Cannot predict now","Concentrate and ask again","Don't count on it","My reply is no",
	"My sources say no","Outlook not so good","Very doubtful");
	$content = substr($content, 7, length($content)+1);
	broadcast("Magic 8-Ball... " + $content, $freq, $source, $job);
	broadcast($8ball + ".", $common, "Magic 8-Ball", "Magic 8-Ball");
	
}
Retrieved from "https://ftl13.com/w/index.php?title=NT_Script&oldid=1677"