Index
Making a Program Data Types: string stringlist integer integerlist extraptr unitptr cmdptr zoneptr Messages: SFB_CMD SFB_DONE SFB_TICK SFB_COM SFB_DEAD SFB_MSG SFB_PRE Built-In Variables cmdstr excmdstr excmdstr_case self activator target medium power argument heartbeat null weather mud(day,month,..) realtime DIL Constructs: if(...) goto while(...) break continue on .. goto .. foreach(...) Assignment Expressions: Operators in string in string string in stringlist string in extraptr Functions: quit return return() Fields: extraptr unitptr UNIT_ST_OBJ UNIT_ST_ROOM UNIT_ST_PC and UNIT_ST_NPC UNIT_ST_NPC UNIT_ST_PC Built-In Functions: asctime(...) atoi(...) cancarry(...) check_password(...) command(...) delstr(...) delunit(...) dildestroy(...) dilfind(...) equipment(...) filesize(...) findroom(...) findrndunit(...) findsymbolic(...) findunit(...) fits(...) getcolor(...) getword(...) getwords(...) ghead(...) isaff(...) islight(...) isplayer(...) isset(...) itoa(...) left(...) length(...) load(...) loadstr(...) meleeattack(...) meleedamage(...) mid(...) moneystring(...) opponent(...) openroll(...) pathto(...) paycheck(...) purse(...) replace(...) restore(...) right(...) rnd(...) savestr(...) send_pre(...) skill_name(...) spellindex(...) spellinfo(...) split(...) strdir(...) strcmp(...) strncmp(...) textformat(...) tolower(...) toupper(...) transfermoney(...) visible(...) weapon_name(...) weapon_info(...) Built-In Procedures: acc_modify(...) act(...) addaff(...) addcolor(...) addequip(...) addextra(...) addstring(...) attack_spell(...) beginedit(...) block cast_spell(...) changecolor(...) change_speed(...) clear(...) dilcopy(...) delcolor(...) delete_player(...) destroy(...) exec(...) experience(...) flog(...) follow(...) gamestate(...) insert(...) interrupt(...) killedit link(...) log(...) logcrime(...) nopriority on_activation(...) pagestring(...) position_update(...) priority reboot remove(...) reset_level(...) reset_vlevel(...) reset_race(...) secure(...) send(...) sendtoall(...) sendtoalldil(...) sendtext(...) sendto(...) send_done(...) set(...) setbright(...) set_fighting(...) setweight(...) set_password(...) store(...) stop_fighting(...) subaff(...) subextra(...) substring(...) unequip(...) unitdir(...) unsecure(...) unset(...) wait(...) walkto(...) Ending Notes
Making a program:
You define your DIL programs within your zone file. Each program you make is a *template*. Such a template must be equipped with a unique name (for that zone). Templates can either be defined in a new %dil section, just below the %zone section in the zone file, or directly attached to units defined in your zonefile.
If you define your DIL templates inside a unit definition, that unit is automatically assigned a program using that template. If you want to use an already designed template, either in your own, or another zone, you use a special function named "dilcopy", that takes the name of a template, and any optional parameters in parenthesis. The parameters of a template called with 'dilcopy' may only be of types integer, strings and stringlists.
Example: dilcopy myfunc@myzone("say Hello, my friend!", 1, CMD_SAY, {"name1", "name2"}); DIL templates can always be reused. In fact, with version 2.0 of DIL, programs are no longer saved with equipment, but only a symbolic reference is used. That way, if you make a change in your zone, ALL units using that program are changed. This however requires you keep the name. Upon loading, if a template is not found, the program is halted and rendered useless until such a reference can be found during loading.
Technical note:
When you use several 'dilcopy' in your zonefile, only one instance is present
game-time, thus saving tremendous amounts of memory. It is similar to a shared
library, in which code is shared but variables are not.
You may use your templates to define both procedure and functions for your other
templates to call.
A template is defined by beginning with 'dilbegin' and ending with 'dilend'.
Inside the template your program section is defined, marked by the keyword 'code',
followed by the program itself;
dilbegin myprogram();
var
i : integer;
j : integer;
code
{
heartbeat:=PULSE_SEC*5;
:start:
exec("say Hello world", self);
pause;
goto start;
}
dilend
This simple template does nothing but making its owner say 'Hello world' once
every 5 seconds. The template is called 'myprogram' and takes no arguments. The
'pause' command waits for the program to receive a timer message, whose interval
is set by the 'inline' variable 'heartbeat'. The 'self' variable is a unitptr
referring to the unit owning the DIL program. Other inline variables will be
explained later.
For a DIL program to work, it must be part of a *unit*: a room, player, non-player
or object. The program uses *messages* to operate. Your program gets activated
when it receives a message that some command is being executed, or a certain amount
of time has passed. You decide yourself in the program, what to wait for, before
the program continues executing.
Supposing you want your program to contain variables, you have to put them in a
section before the 'code' section marked 'var'. The variables are declared by
their type and their name, separated by a ':' and ended by a ';'
For an example, see the program above. Variables of type 'string', 'stringlist'
and 'integer' are saved, if the unit the program is attached to is saved with
player inventory. Variables of type 'unitpr' and 'extraptr' are 'volatile'. This
means that they are cleared whenever there is a chance that their contents may
have been rendered non usable. This ensures that you do not have any 'loose'
pointers. However it is possible to 'secure' the contents of a 'unitptr' type
variable of a unit located in your local environment (the units directly 'visible'
to the unit who owns the DIL program) (see the secure / unsecure functions).
Type:
This variable type allows you to keep an ordered list of integers with out
having to create a variable for each integer.
Example:
If you set a index that is higher then the highest index, every index in
between will be set to zero. For example if you only have two values in the
intlist and you set index value 10 to 50 all indexes between 2 and 10 will be
set to 0.
Example: See Also:
Data Types:
DIL supports a fixed set of types you can use and manipulate. Through these, you
can get and manipulate information about almost anything in the game. The types
are listed below:
String:
A string is some text. They are used for a lot of things such as command
arguments, room descriptions etc. String variables are automatically resized and
allocated when you assign them, so you do not have to worry about the string
length nor allocation in your DIL programs. Strings may be compared either with
'==' (equal to),
'!=' (not equal),
'<=' (less than or equal to),
'>=' (greater than or equal to)
'<' (less than),
'>' (greater than.
Static strings are defined just as in the rest of the zone, within double
quotations. Strings may be searched easily with the 'in' operator. Variables
of type string are saved with DIL programs, if attached to a saved unit.
Example:
"This is a static string"
Strings may also be added to each other, in an expression.
Example:
"say "+itoa(42)+" is the answer!"
Example:
if (self.name == self.names.[1]) ...
Elements of the string can also be accessed by referencing them by their position.
Example
if (str.[3]==f])
{
exec ("say The 4th element is a F.",self);
}
Note
Currently you can only access the single elements of a string you can not set
them. In the future this will be possible. You can still accomplish this by
copying one string to the other one element at a time and changing any that you
want something like this.
Example
i:=0;
ln:=length (str);
while (str.[i]
Integer:
Non-fraction numbers can be used throughout your DIL programs. They are given
normally, or in normal C style hexadecimal, preceded with '0x'. Integers are
signed 32-bit integers. Variables of type string are saved with DIL programs,
if attached to a saved unit.
Example:
0x10
Example:
2
Integers are used within expressions as both number value and boolean(true/false)
values. You may use comparison between integers through the comparison operators:
'==' (equality),
'<' (less than),
'>' (greater than),
'<=' (less or equal),
'>=' (greater or equal)
'!=' (not equal).
Example:
if (42<12) ...
Returning the boolean value (true/false) depending on the comparison between
integers. The result may be stored in an integer variable, and tested later, or
used directly in an 'if' or 'while', etc. You may also operate on boolean
expression themselves, using LOGICAL operators 'and','not','or', which allows
you to combine the expressions.
Example:
if ( not ( (self.hp<42) or (self.level>10) ) ) ..
Integer expressions may also use a number of other operators:
'+' (addition)
'-' (subtraction/negation),
'*' (multiplication),
'/' (division),
'|' (bitwise or, for flags),
'&' (bitwise and, for flags)
Precedence rules for using these operators are still somewhat messed up. You'd
better use parenthesis where ever possible.
Intlist:
Intlists are an array of integer types. They can be set directly as follows:
Example
wpn:={5,3,6,9,3,9};
The intlists can be accessed in the same way stringlist are accessed as follows.
Example
if (wpn.[5]==5)
{
do something
}
The intlists are saved on savable units.
5.3 The Integer List
intlist
Setting an intlist
myintlist:={1,5,9,2,8,5};
myintlist.[10]:=50;
Using intlists
if (myintlist.[5]==5){
stuff
}
if (myintlist<myint){
stuff
}
i:=0;
ln:=length(myintlist);
while (i<ln){
myintlist.[i]:=i;
i:=i+1;
}
Extra descriptions, quests structures, etc can be searched and manipulated using variables of this type. There is no way to declare static structures of this type in DIL programs. Lists of extra descriptions are easily searched with the 'in' operator (See below). Extraptr variables are 'volatile', and thus cleared whenever there is a possibility that they are rendered unusable.
Type: cmdptr
cmdptr fields
name
string - command name