NiM5 Documentation: Script

NiM5: Scripting language helps

Topic: SCRIPT
Keywords: SCRIPT

Syntax:

NiM5 employs an interpreted scripting language to provide an
extensible, life-like world. This language is an artificial
life meta-language for C.

The language is function-based, simple to understand, and
has a set of live tools which aid scripters develop new
scripts; including a full-screen debugger, virtual actor
studio and debug notification system.

Example:
func( { literal }, parameter );
if ( conditional,
{
code
},
{
else
} );
label(end);

See Also: Functions, Reserved, Links, Triggers, Design

Topic: AUTOMATONS
Keywords: AUTOMATONS TRACE

Syntax:

From within the SCEDITOR, an immortal may wish to generate a quick
scripted set of actions for an Actor.

First, clear the script's command list, or enter a few commands
to the beginning of the script, including the Autowait() function.
Autowait sets the pace of the executed commands following
this call.

Exit the script command editor, but still from within SCEDITOR,
use "TRACE" to toggle "action tracing" features of the SCEDITOR.
Begin to perform the actions, walking around the map, talking,
drawing and sheathing your sword, performing socials, etc.

When you are finished, stop recording your actions by typing
"TRACE" again. This deactivates the command and allows you
to begin examining the script it has recorded.

This is a useful way of creating simple actions for non-aggressive,
action oriented "bystanders" or simple repetitive actions.
You may want to set "Traced" scripts to trigger on Each, Tick,
Enter, Say or Moves.

Example:
(of a traced script)
autowait(14);
do({n});
do({e});
do({say Hello!});
do({draw});
do({:growls angrily.});
do({k dragon});

See Also: SCEDIT, Autowait()

Topic: TRIGGERS
Keywords: TRIGGERS

Syntax:

Different triggers can be used in combination to create an active Actor
or Prop. Command scripts respond to a special command typed by the
player; while a Say script listens for text spoken nearby to the scripted
entity.

Each script is written for this single purpose, and the type of
trigger defines the type of script you will write.

For a command script, an if() statement is used to test the incoming
text stream. This is almost identical to a Say script.

In the case of Enter or Moves, scripts are triggered based on
the actions of each individual in the scene.

Other types of scripts include 'Each' which is triggered constantly
each pulse, and 'Tick' which is only triggered when reset.

There are also the Dies and Born scripts, which are related to Cues
and to Combat.

There are also special trigger types 'Spell', used for spell-related
scripts triggered by the 'Invoke' or 'Cast' command, as well as the
'Combat' script, which is triggered during combat.

Example:

See Also:

Topic: ACT()
Keywords: ACT() OUT()

Syntax:
act(phrase, source, object, target, type);

Similar to the mud's internal routine of the same name, act() is
an output function. Use with caution. Act() codes are special
codes using dollar signs ($$) to denote special characters.
act(phrase, character, object1, object2, act-type);
Act codes and act types:
Types: 0=scene, 1=notvict, 2=vict, 3=char, 4=all
Codes: $$n v p s c t m
$$N V P S C T M

Act codes (addendum):
0-7 colors; R normal text, B bold text, F flashing, I inverse
t or T: target is string, n or N name, e or E he or she, m or M him/her
s or S his/her, i are/is, v or V "" or s (for verb plurality),
w or W "" or "es" (for verb plurality for words ending in s),
x or X "y" or "ies" (for verb plurality ending in y such as carry),
y or Y, used in conjunction with a name, returns "r" or "'s" to show
ownership; for instance $$n$$y may display your or Harold's,
k or K, similar to i, are/is, p or P, returns object name,
d, returns direction.

Lower case refers to "object" or "source", upper case refers to target
or object2.

This function is rather complicated and should be used with caution.
Double-dollar-sign displays a regular dollar sign ($$$$)

Example:

See Also:

Topic: AUTOWAIT()
Keywords: AUTOWAIT()

Syntax:
autowait(#pulses);

Sets the autowait timer to the number of pulses specified.

The autowait timer is a script-based timer that automatically paces
a script by a certain number of pulses, delaying each line.

Example:

See Also: Functions, Functions2, Wait()

Topic: CLOSE()
Keywords: CLOSE()

Syntax:
close(location,direction);

Closes a door.

Example:
close(here(),east);
close(here(),5);

See Also: Open(), Functions

Topic: DATE
Keywords: 'DATE FUNCTIONS' Day() Month() Year() DayofWeek() Moon() Weather()

Syntax:
.
date();
time();
weather();
moon();
dayofweek();
month();
year();

A series of functions which provide access to the values stored in
the game's weather, date and time functions. These are not the
system time, or the user's system time, but rather the game's ongoing
calendar and weather system.

Example:

See Also: Math Functions, Functions, Functions2

Topic: DEATH()
Keywords: DEATH()

Syntax:
Death( target, vnum )

Sets the death vnum of a target.
(Room vnums only)

Example:
death(%aname%, 1) -> when a player dies, he/she reincarnates in limbo

See Also: Home(), Functions

Topic: DISARM()
Keywords: DISARM()

Syntax:

Disarm( target );

Removes all top-layer weapons from a actor.

Example:

See Also:

Topic: DISPENSE()
Keywords: DISPENSE()

Syntax:
dispense(target,vnum);

Dispenses an object to the target.

Example:
dispense(rndplr(here()),11113);

See Also:

Topic: DO()
Keywords: DO()

Syntax:
do( command );

Caller of the script performs a command. Caller must be a actor.

Example:
do({'Hello!});
do(dance);
do(kill fido);

See Also: Functions

Topic: DREAM()
Keywords: DREAM()

Syntax:
dream(text);

The dream() function sends a string of text to any actor who is
asleep in the same area as the caller.
(For objects, in the area it was created.)

Example:
dream({You dream of little wooley lambs jumping over fences.});

See Also: Functions, Functions2

Topic: EAT()
Keywords: EAT()

Syntax:

EAT( target );

The eat() function quietly disposes of an object.

Syntax:
eat(sword);
eat(ticket);

Example:

See Also:

Topic: ELUDE()
Keywords: ELUDE()

Syntax:
elude();

If this function is called by an actor, actor's followers
cease following.

Example:

See Also:

Topic: EVENT()
Keywords: EVENT()

Syntax:

Not yet implemented.

Example:

See Also:

Topic: FORCE()
Keywords: FORCE()

Syntax:

Function acts like a force() command. Usage:
force( <target> <command> );

Example:

See Also:

Topic: FUNCTIONS
Keywords: FUNCTIONS 'SCRIPT FUNCTIONS' FUNCTIONS1

Syntax:

SCRIPT-FUNCTIONS
MATH-FUNCTIONS
LIST-FUNCTIONS

PROP-FUNCTIONS
ACTOR-FUNCTIONS
SCENE-FUNCTIONS

SPELL-FUNCTIONS

GRAPHICS-FUNCTIONS
VALUE-FUNCTIONS

Type 'help <TYPE>-FUNCTIONS' for a breakdown of functions and parameters.

To get help on a particular function, type 'HELP FUNCTION()'

Example:

See Also: master-list

Topic: FUNCTIONS2
Keywords: FUNCTIONS2 FUNCTIONS_2 'FUNCTIONS 2'

Syntax:

Newly added game functions:

mana(); event(); mix(); reagents();
dispense(); skill(); alert(); tname();
dig(); undig(); rnddir(); rtitle();
reverb(); emit(); transform(); getdir();
rndplr(); bomb(); spawn(); pay();
level(); setskill(); queue(); props();
commands(); act();

Example:

See Also:

Topic: GOTO()
Keywords: GOTO()

Syntax:

GOTO( label );

The function goto() jumps to a label defined with the label() function.

Syntax:

label(start);
do({say Hello!});
wait(1000);
--> goto(start);

To use a goto() function from within an if() conditional, make sure
to use {, } curlie brackets surrounding that call, otherwise, the
code will execute immediately.

Example:

See Also:

Topic: HOME()
Keywords: HOME()

Syntax:
Home( target, vnum )

Sets the home vnum for a player.

Example:
home(%aname%, 500) -> sets a player's home to room vnum 500

See Also: Death()

Topic: IF()
Keywords: IF()

Syntax:

IF( expression, iftrue, iffalse );

The if() function acts as a conditional statement.

Syntax:

if( %variable%, {do(stand)}, {goto(start)} );

Example:

See Also:

Topic: IN()
Keywords: IN()

Syntax:
in(a,b);

Similar to str_infix(), returns if string a matches any substring of
string b. Almost identical to strstr(), but lacks case sensitivity.

Example:
in({bbbb},{aaaabbbbcccc}); *returns true
in({xxx},{aaaabbbccc}); *returns false

See Also: Pre(), Cmp(), Strstr(), Functions, Functions2

Topic: JUMP()
Keywords: JUMP()

Syntax:

JUMP( dest );

The jump() function moves the script caller to a destination.

Syntax:
jump(601);

Example:

See Also:

Topic: LABEL()
Keywords: LABEL()

Syntax:

LABEL( name );

The label() function defines a label to jump to with the goto() function.

Syntax:

--> label(start);
do({say Hello!});
wait(1000);
goto(start);

Example:

See Also:

Topic: MACRO-FUNCTIONS
Keywords: 'Macro Functions' MACRO-FUNCTIONS

Syntax:

These functions (which are not yet fully implemented) enable
macro-functions, local or master functions, to be created and
manipulated.

vset(); vget(); vcpy(); return(); halt();

Example:

See Also:

Topic: MANA()
Keywords: MANA()

Syntax:

Mana( target, gain );

Gain, either positive or negative, an amount of mana on the target.

Example:

See Also:

Topic: MATH
Keywords: 'MATH FUNCTIONS' BOR() BXOR() NOT() OR() AND() LESS() GREATER() RANDOM() BAND() ADD() SUB() MULT() DIV() MOD()

Syntax:
.

bor(a,b); binary or
bxor(a,b); binary xor
not(a); inversion
or(a,b); or
and(a,b); and
less(a,b); less than
greater(a,b); greater than
random(a,b); returns a random integer
band(a,b); binary and
add(a,b); addition of a and b
sub(a,b); subtraction of a and b
mult(a,b); multiplication of a and b
div(a,b); division of a by b
mod(a,b); modula of a by b

A series of functions to perform simple arithmetic operations.

Example:

See Also: Functions, Functions2, Scripts

Topic: MOVE()
Keywords: MOVE()

Syntax:

MOVE( target, dest );

The function move() moves a target actor to a destination location.

Syntax:

move(%aname%, 500);
move(me, 500); <-- equivalent to jump(500);

Example:

See Also:

Topic: MOVEALL()
Keywords: MOVEALL()

Syntax:

Moveall( from, to );

This function moves all players from one location to another.

Syntax: Moveall(500,501);

Example:

See Also: Move()

Topic: NUMW()
Keywords: NUMW()

Syntax:
numw(list);

Returns the number of words in a string. Words are defined as strings
delineated by spaces.

Example:
numw({you me them us}); *returns 4

See Also:

Topic: OPEN()
Keywords: OPEN()

Syntax:
open(location,direction);

Opens a door.

Example:
open(here(),rnddir());
open(here(),east);
open(here(),3);

See Also: Close(), Functions, Functions2

Topic: PAY()
Keywords: PAY()

Syntax:

Pay( target, amount );

Tenders money to a target.

Example:

See Also:

Topic: PERMHALT()
Keywords: HALT() PERMHALT()

Syntax:
Permhalt(); Halt(value);

Permhalt(); perminantly halts a script for debugging purposes.

Halt(value) halts a script returning a value.

Example:
halt(10);
permhalt();

See Also: Notify, Functions, Functions2, Scripts

Topic: POS()
Keywords: POS()

Syntax:

POS( target, value );

Sets the position of a actor target.

Example:

See Also:

Topic: PRE()
Keywords: PRE()

Syntax:

Similar to str_prefix(), returns a "true" (>0) value for strings
which match their prefixes.

Example:
pre(abba,abbadabba); *returns true
pre(aabb,xaabb); *returns false (0)

See Also: Cmp(), Functions, Functions2

Topic: PURGE()
Keywords: PURGE()

Syntax:

Function that deletes an object, room or actor.

purge( target );

Example:

See Also:

Topic: RANDOM()
Keywords: RANDOM()

Syntax:
add( a, b )

Function returns a random number in a range from a to b.

Example:
random(0,7) -> returns random number between 0 and 7
random(%astr%,7) -> returns random number in the range %astr% to 7

See Also: Add(), Variables, Functions

Topic: RETURN()
Keywords: RETURN()

Syntax:
return(#value);

Sets the return value for a script. This is to be integrated into
multi-script parser, which is not fully implemented yet.

The idea is that scripts can be stored as functions in a master or
local command list. This provides an on-the-fly creation of functions
or macro-functions to aid the language. Similar to encapsulation,
a feature of polymorphic (object-oriented) languages.

Example:
return(10);

See Also: Functions, Functions2, Macro-Functions

Topic: RNDDIR()
Keywords: RNDDIR()

Syntax:

Rnddir() returns a random direction.

Example:

See Also:

Topic: RTITLE()
Keywords: RTITLE()

Syntax:

syntax: rtitle( room, {newtitle} );

Sets the title of a room in a script.

Example:

See Also:

Topic: SAMEROOM()
Keywords: SAMEROOM() SAMESCENE()

Syntax:
samescene(target);

Function returns 0 or 1 (false or true) if the caller is in the same
scene as the target. May be samescene();

Example:

See Also: Functions, Functions2

Topic: SCRIPTS
Keywords: SCRIPTS

Syntax:

NiM5 includes a proprietary script interpreter. A memory hog, NiM5's
scripts are parsed on the fly.

Example:

See Also: Script Language, Functions, Math Functions, Functions2

Topic: SCRIPT_LANGUAGE
Keywords: 'SCRIPT LANGUAGE' SCRIPTS SCRIPT

Syntax:

The proc/script language is designed to provide somewhat flexible
artificial life routines. NIM scripts are versatile enough to produce
many varied applications including: levers, doors, responsive actors,
scenes that change their description, vaults, automatons, et cetera.

The language is function-based and superior in versatility to previous
versions. Scripts can be written for actors, props and rooms.

See also: FUNCTIONS, VARIABLES, TRIGGERS, EXAMPLES

Note, read "help curlies" for information on syntax of the
interpreter. It helps!

Example:

See Also:

Topic: SELF()
Keywords: SELF()

Syntax:
self();

Function returns the name of the caller.

Example:
%myname% self();
do({'Hello, my name is %myname%.});

See Also: master-list,

Topic: STRIP()
Keywords: STRIP()

Syntax:

Strip( target );

Removes all of the possessions of an actor.

Example:

See Also:

Topic: STRSTR()
Keywords: STRSTR()

Syntax:
strstr(a,b);

Finds substrings. Case sensitive. Returns a value equal to the
substring's index within the string. 0 (false) means not found.

Example:

See Also: Functions, Functions2, Cmp(), In(), Pre()

Topic: TIME()
Keywords: TIME()

Syntax:
Time( );

Returns the game's hour.

A number from 0-23.

Example:

See Also: Day(), DayOfWeek(), Month(), Weather()

Topic: TRIGGERS
Keywords: TRIGGERS

Syntax:

A script is called by an acting trigger which supplies the proc with needed
information. Triggers are called from a variety of sources denoted below:

Triggers Types Events

COMMAND All When a Command is Typed
EACH_PULSE Actors/Objs Triggered Each Pulse
COMBAT All Each Round
TICK_PULSE All Tick Room = When Reset
BORN All Creation Room = On Startup
GETS Objs When Taken
SAY All Any communications (Not Fully Implemented)

KILLS Actors/Objs Kills
DIES Objs/Room Dies Nearby Actor = Upon Death
ENTER All Someone Enters
MOVES Actors/Room Someone Leaves

LOOKS All Called when looked at.

Example:

See Also: Parameters

Topic: VARIABLES
Keywords: VARIABLES

Syntax:

Variables in NIM scripts are dynamically created when referred to. If
a variable does not already exist in a running script's memory, it is created
with the name given. Variables are parsed in the code as any alphanumeric
string contained within percentage symbols. Variables are either strings,
objects, rooms, actors or numerics. There is no delineation between string
variables and parsed numerics.

Syntax:

%name% = {citizen};
%afoo% = {Hello, %name%};
do({say %afoo%});

See also: POINTERS

Example:

See Also:

Topic: WAIT()
Keywords: WAIT()

Syntax:
wait(#pulses);

Delays / pauses a script for a certain number of pulses.

Pulses are not very long. There are 3 pulses per combat round,
and 4 per update tick, which is about one second.

Example:
do({'I say this immediately.});
wait(10);
do({'I say this after 10 pulses.});

See Also: Autowait(), Functions, Functions2

Topic: Style
Keywords: style

Syntax:

Coding styles; ways to create various types of machines / scripted
actions.

Example:

See Also:

Topic: MATH-FUNCTIONS
Keywords: math-functions

Syntax:

to perform quick arithmetic and boolean operations to integer values.
All are integer-only functions; floating point functions are not
implemented. For PI, use 3.
not(a) !a not
or(a,b) a||b or
and(a,b) a&&b and
less(a,b) a<b less than
lt(a,b) a<b less than (shorthand)
greater(a,b) a>b greater than
gte(a,b) a>b greater than (shorthand)
bor(a,b) a|b binary or
xor(a,b) a^^^^b xor
bxor(a,b) a^^b binary xor
band(a,b) a&b binary and
add(a,b) a+b arithmetic addition
mult(a,b) a*b multiplication
sub(a,b) a-b subtraction
mod(a,b) a%b a modula b
div(a,b) a/b division, div0 returned for divide by zero err
inc(a) a++ increment
dec(a) a-- decrement
eq(a,b) a==b integer operation "equals"
random(a) Returns a random value 0-a
random(a,b) Returns a random value in range a-b
range(a,b) Returns a random value in range a-b
gelify Randomly "gelatinously" modifies a number
fuzzy Puts some fuzz on a number.
dice(a,b) Roll dice of sides a, b times
int(a,b,c) Linear interpolation.
interpolate(a,b,c) Linear interpolation.
min(a,b) Returns the minimum, or if b is greater, b
max(a,b) Returns the maximum, or if b is less, then b
urange(a,b,c) Unsigned range, a-c
lineate(a,b,c) Performs a lineation algorithm.
Ratio(a,b) Generates a percentage of a/b*100

Example:

See Also:

Topic: GRAPHICS-FUNCTIONS
Keywords: graphics-functions

Syntax:

Graphics functions work with the internal graphics buffer and are grouped
under the sub-system 'Ascii Graphics Engine' - a specialized MXP-enabled
ascii GUI/typesetting renderer. Utilizes a frame buffer with dynamic
resolution to store a screen buffer, which can be displayed to the user.
box(x,y,dx,dy) Draw a box using the current line style
rect(x,y,dx,dy) Draw a rectangle using the current brush
line(x,y,dx,dy) Draw a line using the current brush
circle(x,y,r) Draw a circle of radius r at x,y using current brush
color(a) Returns a color code, 255 if MXP, 16 colors if ansi
stroke(a) Set the color for drawing (see above)
point(x,y) Draws with current brush at x,y
draw or draw() Displays the current contents of the frame buffer
blank or blank() Blanks the frame buffer, redraws ruler (see rulers)
gmode(x,y) Sets the resolution of the framebuffer, x-size, y-size
By default, the frame buffer is usually 77x25
mode(0|1) same as below (?)
style(0|1) boxstyle setting, 0=thin 1=thick
ruler(0|1) toggles debug ruler; 0=off 1=on, mud-boot default=1
rulers or rulers() Returns the current value of the rulers toggle
clear or clear() Clears the screen, determined by 'set clrscr'
brush(c) Sets the 'brush' character
hline(y) Draws a horizontal line with the current brush
vline(x) Draws a verticle line with the current brush
column(x,y,w,{t}) display text in a formatted column (unimplemented)
wrap({text}) Wordwrap standard formatting 77 character
fill(x,y,dx,dy) Fill an area with the current brush character (?)
fills(x,y,dx,dy,s) Fill an area with a string, used w/ column (?)
text(x,y,{content}) Draws text content at x,y
textline(x,y,dx,dy,{content}) Draws text content along a line x,y->dx,dy
popup(x,y,w,h,{title}) Display a box with a title
button(x,y,{label}) Display an MXP button

Example:

See Also:

Topic: PROP-FUNCTIONS
Keywords: prop-functions

Syntax:

Prop-related functions that examine or manipulate the interior data stored
on a prop; values and bonuses, prop-related or prop-command functions.
here or here() Returns the vnum of the current room.
pset(a,b) Set variable a to b (see prop command for variable names)
propname() Return a prop name
propdesc() Return a prop description
propshort() Return the prop's short description
proplong() Return the prop's long description
propaction() Return the prop's action description
setpropshort(s) Set's a prop's short description
setproplong(s) Set a prop's long description
setpropname(s) Set a prop's name (keywords)
setpropaction(s) Do not use on weapons.
It is impossible to change a prop's description at this time.
v1 or v1() Return the value of the prop's value1
v2 or v2() Return the value of the prop's value2
v3 or v3() Return the value of the prop's value3
v4 or v4() Return the value of the prop's value4
itemtype Return the Item Type Number
setitemtype(#) Set Item Type Number
setextraflags Set Extra Flags by Number
extraflags Extra Flags
setwearloc(#) Set the wear location by Number
wearloc Return the wear location by Number
setweight(#) Set the weight
weight Set the weight
setcost(#) Set the value of the cost
cost or cost() Return the cost associated with an object
settimer(#) Set the prop's timer
timer(#) Return the timer's value
size or size() Return the prop's size
setsize(#) Set the prop's size value

dispense(t,v#) Dispenses a prop of v# to target t; called on any type
transform(v#) When called on a prop, transforms itself to new v#
broadcast({txt}) When called on a prop script, sends txt to all props
in existence with the same vnum as the prop

Example:

See Also:

Topic: ACTOR-FUNCTIONS
Keywords: actor-functions

Syntax:

Actor-related functions that examine or manipulate the interior data
stored on an actor; values and bonuses, actor-related actions and
movement commands.
do() Up to six seperate parameters; executes mud commands as though
typed works primarily on Mobs
setskill(t,v#,v) Sets a skill to a certain skill level on a target
step(v#) Take a step toward scene v#, uses subset of track command
aset(a,b) Sets a to the value of b, similar to pset but for actors
jump(v#) Moves the owner to the scene v#
samescene(t) Returns TRUE if owner is in the same scene as the target
foe() or foe Returns the name of the actor's foe
has(t,v#) Returns TRUE if target is in possession of v#
skill(t,v#) Returns the skill level of the target's skill (vnum)
disarm(t) Removes weapons from the target actor
strip(t) Removes all items in possession of the target actor
pos(t,g)
pay(t,g)
elude or elude() Removes all followers from the actor-owner
home(t,v#) Changes a target's home to a new destination vnum
death(t,v#) Changes a target's destination upon death
heal(t,g) Heals a target t for an amount g
hurt(t,g) Hurts a target t for an amount g
damage(t,g) Damages a target t for an amount g
bomb(v#,g) Bombs a target scene for amount g - all players hurt
actorname() Returns the actor name
setactorname(s) Sets the actor keywords
setdescription(s) Sets the description
description(s) Returns the description
short(s) Returns the short description
setlong(s) Sets the long description on an actor
long(s) Returns the long description
level(t) Returns the level of the target
setposition(t,#) Sets the position
position(t) Position
setkarma(t,#) Sets the karma
karma or karma(t) Returns karma
modstr(t) Returns the strength modifier
setmodstr(t,#) Sets the mod strength
modint(t) Returns the intelligence modifier
setmodint(t,#) Sets the mod intelligence
modint(t) Returns the intelligence modifier
setmodint(t,#) Sets the mod intelligence
moddex(t) Returns the dexterity modifier
setmoddex(t,#) Sets the dexterity modifer
modwis(t) Returns the wisdom modifier
setmodwis(t,#) Sets the wisdom modifier
armor or armor(t) Returns the armor class of a target
setarmor(t,#) Sets the armor class of a target
hitroll(t) Returns the hitroll of the target
sethitroll() Set the hitroll on a target
damroll() Returns the damroll of the target
setdamroll() Sets the damroll on a target
exp() Returns the experience gained on a target
setexp() Sets the experience gained on a target
dispense(t,v#) Dispenses a prop of v# to target t; called on any type
create(v#,tv#) Dispenses a prop of v# to scene tv#
eat(t) Disposes of a target prop
eat or eat() Dispose of self, useful for consumable objects

Example:

See Also:

Topic: SPELL-FUNCTIONS
Keywords: spell-functions

Syntax:

Spell-related functions for use with both elemental and alchemical
systems.
mana(t,g) Modifies the mana of a target t by gain g
mix(t,types,quantities)
Attempts to mix reagents of mage t, returns TRUE if succeeds, types
and quantities quantify 1:1, ex:
mix(Locke, 10 2 33 201 222, * mixes components 10,2,33,201,222
1 1 1 2 1 ); * one of each, 2 of component 201
reagents(t,types,quantities)
Checks to see if a mage t has the required reagents, returns TRUE if
quantities are in the possession of the mage t
reagents(Locke, 10 2 33 201 222, * components index list
1 1 1 2 1 ); * one of each, 2 of component 201

Example:

See Also:

Topic: COMMAND-FUNCTIONS
Keywords: command-functions

Syntax:

Command-related functions for use with objects and actor-instantiated
aliases (command scripts on actors/players).
A command must use the return(1); statement if it is successfully
executed. Command scripts usually take the form:
* begin command script
if ( pre(%astr%,{command_name}),
{
* successful
do({:the command.});
return(1);
} );
* end command script
If the above form is not used, the command script will execute
regardless of any specific triggering command name or phrase,
and is essentially a way to trigger a script if someone is in
the scene and types any command. Without the return(1) statement,
other commands will attempt to execute if the triggering input phrase
matches the command phrase of command table commands, or of other
scripted command objects.

Example:

See Also:

Topic: SCRIPT-FUNCTIONS
Keywords:

Syntax:

These functions are the basic structure of the language.
label({label}) Specify a label for reference with goto function.
goto({label}) Go to a specified label in a script.
if( exp, A conditional expression, useful
{ *true in filtering incoming data,
do-this; randomizing events and decision
}, trees. Also can be used to build
{ *else case statements by nesting.
do-that;
} ); The second parameter is optional.
return(#) Sets the return value and halts the script. <-COMMANDS
halt or halt(#) Halts a script, with optional return value.
permhalt(#) Permanent halting of a script with optional return value.
wait(#) Delays the progression of the parser for # of pulses
autowait(#) Sets a repeating delay of # pulses, useful with TRACE
call(name,target) Not yet implemented. Attempts to trigger a script.
install(target,v#) Installs a script on a target; triggering it.
uninstall(target,v#) Removes all instances of a script v# from a target.
self or self() Returns a pointer/name to the owner of the script.
vcpy(o,n,name) Not yet implemented. Copies variables.
pcmp(a,b) Pointer comparison for non-string variables.
null or null() Returns 0
eval(v) Evaluates a scripting language expression

Example:

See Also:

Topic: STRING-FUNCTIONS
Keywords: string-functions

Syntax:

String manipulation and analysis.
cmp(a,b) Returns TRUE if a is identical to b
pre(a,b) Returns TRUE if a is a prefix of b
in(a,b) Returns TRUE if a is an infix of b
strstr(a,b) Returns an integer index of the start of b in a
cat(a,b) Returns a concatenation.
word(a,#) Splits the string into individual words, then returns word #
echo(t,{txt}) Displays text to a given target; see multityping
oecho(t,{txt}) Displays text to surroundings of a target; see multityping
dream({txt}) Displays text to all sleeping players in a zone
history(t,{txt}) Adds a text entry to target's history, by name or an actor
numw(#) Returns the numberized version of given number
strp(s,o,n) Replaces in a string s all o with n, returns new string

Example:

See Also:

Topic: LIST-FUNCTIONS
Keywords: list-functions

Syntax:

Functions that manipulate string lists (list/stacks); lists are
space-seperated and can use double quotes (") to contain multiple words in
a single list entry; similar to an array or linked list, but for strings.
example: word word "multiple words" words
index: 1 2 3 4
push(s,v) pushes string v onto stack s
pop(s) pops the top value off the stack and returns it
lrem(s,v) similar to strp(), removes all occurances of v from s
sort(s,m) not implemented
lrnd(s) returns a random value from stack s
lshift(s) shifts all values of the stack one left
rshift(s) shifts all values of the stack one right
empty(s) returns true if stack s is empty
users returns a stack of all of the connected users
foreach(s,c) not implemented, executes code c with %stack% variable s
each(s) not implemented

Example:

See Also:

NiM5: Multi-user gaming software.
Copyright (c) 1992-2004 Herb Gilliland. All Rights reserved.