The Standard Library

From ADRIFT 5 Manual Wiki
Revision as of 02:51, 7 January 2013 by Saabie (Talk | contribs) (Links)

Jump to: navigation, search

Most adventure game's typically uses many of the same commands such as Get, Drop, Inventory, Look, Eat, Read, and the movement directions. Unlike older versions of ADRIFT, ADRIFT 5 does not contain any pre-defined commands in the program itself, but instead loads a large number of these common commands from an extenal file called the standard library. The ADRIFT 5 standard library is stored in a module file called StandardLibrary.amf which is usually located at C:\Program Files\Common Files\ADRIFT\Libraries\

When a new game is started, or an ADRIFT 4 game is upgraded to version 5, the contents of this file is loaded and will be saved to the .TAF file when the game is saved. If a new version of StandardLibrary.amf is installed and a game is loaded from a .TAF file that contains an older version of the library, you will be given the option of loading the new library into the game or not.

Although it is possible to edit the standard library folders, it is much better practice to override tasks in the standard library with specific tasks, or create a new general task for the same command with a higher priority and which prevents the original task from running.

Folders

In the Developer "Folders" window, this library is loaded into a folder called "Standard Library" which has several other folders inside it. The contents of each of these folders is explained in the following sections.

The words between % symbols in the left colomb are called references, and are replaced by the name of an actual object in the game.

%object% is the name of any static or dynamic object, eg. 'pen' or 'large red ball'. If plural then you can also use "All".
%character% is either the proper name or descriptor of a character, eg. 'john doe' or 'tall man'.
%location% is the short description of a location.
%direction% can only be a compass direction, up, down, in or out.
%number% can be any number.
%text% can be anything.

The other words between % symbols in the right colomb are Functions which print the names of the objects and characters being referenced.

Square brackets containing two slashes, such as "[am/are/is]" or "[1]" are alternate versions of the text. The text which is actually shown to the player is controlled by the "Player Perspective" setting on the general tab of the game "Options" (Opened by pressing the spanner icon on the Home ribbon).

  • First Person (I) - Prints the first option, so "%CharacterName% [am/are/is]" becomes "I am" and "%CharacterName% pick[2] up" becomes "I pick up"
  • Second Person (You) - Prints the middle option, so "%CharacterName% [am/are/is]" becomes "You are" and "%CharacterName% pick[3] up" becomes "You pick up"
  • Third Person (Characters name, eg. "John") - Prints the last option, so "%CharacterName% [am/are/is]" becomes "John is" and "%CharacterName% pick[4] up" becomes "John picks up"

Tasks - Uncategorised

There is currently only one task in this folder.

Name Command Description Default Text
inventory [inventory/inv/i] Lists what the player is currently wearing & holding  %CharacterName% [am/are/is] wearing %ListWorn[%Player%]%, and [am/are/is] carrying %ListHeld[%Player%]%.

Properties

This folder contains general properties pertaining to where objects are located, whether the player knows a character, and character gender.

Name For Type Description
On what? Objects Object List (Supporters) Which object this one is sitting on top of
At Location Objects (Static) Location List Location of a static object
Location of the object Objects (Static) State List Is a static object at a single location, part of somebody or something, or in a location group
Is this character known to the Player Characters Selection Only Controls whether Adrift uses the characters name or their description
Object type Objects State List Static (fixed in place) or Dynamic (can be picked up)
Specifically exclude object from location descriptions Objects (Dynamic) Selection Only The object name is not to be given in the "also here is a.." list after a location description
When the object is listed in location, display this Objects Text Instead of just giving the object name, use this description
Part of what Objects (Static) Object List The object is a part of another object, such as a handle on a door
In location Objects (Dynamic) Location List If "Location of the object" is "In location", this gives the location
Part of who Objects (Static) Character List A part of a character, such as nose, eyes, mouth, hand etc.
Held by who Objects (Dynamic) Character List The dynamic object is being held by this character
Gender Characters State List Male, female, or Unknown
At Location Group Objects (Static) Location Group list If a large static object exists in several locations at once, this is the group that lists them
Location of the object Objects (Dynamic) State List Is a dynamic object in a location, held by somebody, sitting in or on something, or hidden from view

Give, Take and Drop

This group of commands allows the player to pick up objects, put them on or in other objects, or give them to another character.

Properties:

Name For Type Description
Object is a container Objects Selection Only Dynamic objects can be put inside this object
Object is a supporter Objects Selection Only Dynamic objects can be put on top of this object
... and the container can hold Objects (Containers) Integer (Object size) How much room is inside this container
... and the surface can hold Objects (Supporters) Integer How many objects can sit on top of this one
Object weight Objects (Dynamic) Value List How heavy is this object
Maximum weight of held items Characters Integer (Object Weight) How much weight can this character carry
Maximum size of held items Characters Integer (Object Size) How large can the objects this character can carry
Object Size Objects (Dynamic) Value List How large is this object

General Tasks:

Name Command Description Default Text
Take Objects (Parent Task) [get/take/pick up] %objects%
pick %objects% up
This task is overridden by the specific tasks in the next table
Take Objects From Object [get/take/pick up/remove] %objects% from %object2%
pick %objects% up from %object2%
Take an object that is inside or on top of another object Ok, %CharacterName% take[5] %objects%.List from %object2%.Name.
Drop objects [drop/put down] %objects%
put %objects% down
put the objects (from players inventory) onto the ground Ok, %CharacterName% put[6] down %objects%.List.
Remove before put put %objects% on{to} {{the} top of} %object2%
put %objects% in{side/to} %object2%
An object that is inside or on top of another object in players inventory, or is worn by the player, is put on or in another object.

Note that the advanced option "Continue executing matching lower priority tasks" allows the apropriate task "Put objects in others" or "Put objects on others" to execute after this one.

<c>(removing %objects%.List from %objects%.Parent.Name first)</c>
Give object to character [give/offer] %objects% to %character%
[give/offer] %character% %objects%
object in inventory goes to another characters inventory  %CharacterName% hand[7] %CharacterName[target]% %objects%.List.
Remove before drop [drop/put down] %objects%
put %objects% down
object on or in an inventory object is put on the ground
If in or on another object print:
If worn print:

<c>(removing %objects%.List from %objects%.Parent.Name first)</c>
<c>(removing %objects%.List first)</c>
Put objects in others put %objects% in{side/to} %object2% object in inventory is put into a container  %CharacterName% put[8] %objects%.List inside %object2%.Name.
Put objects on others put %objects% on{to} {{the} top of} %object2% object in inventory is put onto a supporter object Ok, %CharacterName% put[9] %objects%.List on top of %object2%.Name.

Specific Tasks:

Name General Task Description Default Text
Take Objects From Object (Lazy) Take Objects (Parent Task) Takes the named object(s) from inside or on top of any other object.
Cant be used with "All"
<c>(from %objects%.Parent.Name)</c>
Take Objects From Location Take Objects (Parent Task) Take the named object(s) or "All" objects from the current location Ok, %CharacterName% pick[10] up %objects%.List.

Character Position

This folder controls whether the player is standing up, sitting, or laying down.

It contains 3 object properties and one character state-list property:

Name For Type Description
Characters can sit on this object Objects (Supporters) Selection Only Used for chairs, beds, large logs etc.
Characters can stand on this object Objects (Supporters) Selection Only Step ladders, platforms and anything else they can get on
Characters can lay on this object Objects (Supporters) Selection Only Mostly for beds
Character Position Characters State List Is the character Standing, Sitting or Laying down

And general tasks for sitting, laying down and standing up:

Name Command(s) Description Default Text
Sit On Floor sit {up/down} Sit on the floor:
If currently laying down then:
 %CharacterName% sit[11] down
%CharacterName% sit[12] up.
Sit On Objects sit {up/down} [in/on] %object%
get on %object%
Sit on an object  %CharacterName% sit[13] on %TheObject[%object%]%.
Sit On Current Object sit {up/down} Sit on the object you are currently standing or laying on <c>(on %TheObject[%ParentOf[%Player%]%]%)</c>
---Executes task "Sit On Objects"
Stand On Floor stand {up/down} Stand up if currently sitting or laying down  %CharacterName% stand[14] up.
Stand On Objects stand {up/down} [in/on] %object%
get on %object%
Stand on top of the object  %CharacterName% stand[15] on %TheObject[%object%]%.
Stand On Current Object stand {up/down} If sitting or laying on object, stand on it <c>(on %TheObject[%ParentOf[%Player%]%]%)</c>
---Executes task "Stand On Objects"
Lie On Floor lie {up/down}
lay {up/down}
Lay down on the floor  %CharacterName% lie[16] down.
Lie On Current Object lie {up/down}
lay {up/down}
If sitting or standing on object, lay on it <c>(on %TheObject[%ParentOf[%Player%]%]%)</c>
---Executes task "Lie On Object"
Lie On Object [lie/lay] {up/down} [in/on] %object%
get on %object%
Lay down on the object  %CharacterName% lie[17] on %TheObject[%object%]%.
Leave Object [stand/get/move] [out/off] {of} %object%
exit %object%
leave %object%
Get off of an object  %CharacterName% get[18] off of %TheObject[%object%]%.
Leave Current Object [stand/get/move] up {on {the} floor/ground}
exit
get off
leave
Get off of the object currently on, and stand up <c>(%TheObject[%ParentOf[%Player%]%]%)</c>
---Executes task "Leave Object"

Push and Pull

Just some defaults that need to be overidden with specific commands to do anything.

Name Command Description Default Text
Pull object [pull/tug] {on} %object% Override with a specific task for objects that can be pulled, such as levers  %CharacterName% pull[19] %TheObject[%object%]%, but nothing happens.
Push object [push/shove/press] %object% Override with a specific task for objects that can be pushed, such as buttons  %CharacterName% push[20] %TheObject[%object%]%, but nothing happens.

Conversation

Talking to another character.

Most of these tasks do not output any text because they activate the conversation system which outputs text from one of the topic's on a characters conversation tab.

Name Command Description Default Text
Ask about subject ask about %text% If already in a conversation, ask that character about a topic
Ask character about subject ask %character% about %text% Looks for a matching ASK topic on the characters conversation tab
Tell character about subject tell %character% about %text% Similar to ASK, but looks for matching TELL topic
Say something say %text% If already in a conversation, say something to that character
Say something (Lazy) say %text% If one other character at same location, say something to that character <c>(to %CharacterName[%AloneWithChar%]%)</c>
Say something to character say %text% to %character% Looks for a matching "General Command" topic on the characters conversation tab
Ask about (Lazy) ask about %text% If one other character at same location, ask that character about a topic <c>(%CharacterName[%AloneWithChar%]%)</c>

Open and Close

Open and close a container or a door into another room.

Properties:

Name For Type Description
Open status Objects (openable) State List Indicates whether object is open or closed
Key for lock Objects (Lockable) Object List (dynamic) Which object is the key for this object
Inside what? Objects (Dynamic) Object List (containers) What is this object inside of
Object can be opened and closed Objects Selection Only
Object can be locked Objects (openable) Selection Only Does this object need a key to unlock it
Do not use this for combination locks or latches
Locked status Objects (Lockable) Selection only This appends "Locked" as a 3rd option to Open status

General Tasks:

Name Command Description Default Text
close objects close %object% An open object is closed  %CharacterName% close[21] %TheObject[%object%]%.
Unlock objects key check # Unlock %object1% with %object2% Called by "Unlock objects (lazy)" to check for key <c>(using %TheObject[%object2%]%)</c>
Inside %TheObject[%object%]% is %ListObjectsIn[%object%]%.
Unlock objects with key unlock %object1% with %object2% Try to unlock a locked object  %CharacterName% unlock[22] %TheObject[%object1%]% with %TheObject[%object2%]%.
Inside %TheObject[%object%]% is %ListObjectsIn[%object%]%.
Unlock objects (lazy) unlock %object% Try to unlock an object using its "key for lock"
Open objects open %object% Opens a closed (but not locked) object  %CharacterName% open[23] %TheObject[%object%]%.
Inside %TheObject[%object%]% is %ListObjectsIn[%object%]%.
Open objects with others open %object1% [with/using] %object2% Override with a specific task to open an object using another object  %CharacterName% can't open %TheObject[%object1%]% with %TheObject[%object2%]%.
Lock objects key check # Lock %object1% [with/using] %object2% Called by "Lock objects (lazy)" to check for key <c>(using %object2%.Name)</c>
Lock objects with key lock %object1% [with/using] %object2% Use the "key for lock" object to lock first object  %CharacterName% lock[24] %object1%.Name with %object2%.Name.
Lock objects (lazy) lock %object% Try to lock an object using its "key for lock"

Look and Examine

Display the long description of a location or object, or the "description when read" property.

Properties:

Name For Type Description
Object is readable Objects Selection only You can use the "read" command with this object
... and description when read Objects (readable) Text Display this instead of object description when read
When the object is listed in location, display this Objects Text How to describe object when listed after location description
Specifically list object in location descriptions Objects (Static) Selection Only Causes static object to be listed after location description

General Tasks:

Name Command Description Default Text
Examine characters [examine/exam/ex/x/look {at}] %character% Print the full description of a character  %DisplayCharacter[%character%]%
Examine objects [examine/exam/ex/x/look {at/in{side}/under}] %object% Print the full description of an object  %DisplayObject[%object%]%
Look [look/l] Display the full description of the current location  %DisplayLocation[%LocationOf[%Player%]%]%
Read objects read %object% If object is readable, display its description when read or full description  %DisplayObject[%object%]%

Wear and Remove

Put on an item of clothing, or take it off. Can also be used for armor and jewelry.

Properties:

Property Name For Type Description
Object is Wearable Objects (Dynamic) Selection only Allows an object to be worn by a character
Worn by who Objects (Wearable) Character List Which character is wearing the object

General Tasks:

Task Name Command Description Default Text
Remove objects [remove/take off] %objects%
take %objects% off
Move an object being worn by character to being held by same character Ok, %CharacterName% remove[25] %TheObjects[%objects%]%.
Wear objects [wear/put on/don] %objects%
put %objects% on
Move an object being held by character to being worn by same character Ok, %CharacterName% put[26] on %TheObjects[%objects%]%.

Eat and Drink

Properties determine if an object can be eaten or drunk.

Properties:

Name For Type Description
Object is edible Objects (Dynamic) Selection Only Indicates that object is edible food
Object is drinkable Objects (Dynamic) Selection Only Indicates that object is (or contains) a drinkable fluid

General Tasks:

Name Command Description Default Text
Eat objects [eat] %object% Override this with a specific task to allow an object to be eaten As tasty as %TheObject[%object%]% looks, %CharacterName% [am/are/is] not hungry right now.
Drink object drink %object% Override this with a specific task to allow an object to be drunk As delicious as %TheObject[%object%]% looks, %CharacterName% [am/are/is] not thirsty right now.

Library Messages

Not implimented yet - will allow special messages controlled internally by adrift to be customised or changed to a different language.

Player Movement

Normal player movement, plus getting inside of, or climbing on top of objects.

Properties:

Name For Type Description
What to show when character is at the location Characters Text Replaces the default "John is here" message
Show character entering/exiting the location Characters Selection Only Tells the player if another character moves in or out of the location
Description when enters the location Characters Text What to print if this character moves into location containing the player
Description when exits the location Characters Text What to print if this character moves into location containing the player
Location of the character Characters State List Is this character hidden, at a location, in or on something
At which Location Characters Location List Which location is the character currently at
On which object? Characters Object List (supporters) Which object is this character on top of
Inside which object? Characters Object List (containers) Which object is this character inside of
On which character? Characters Character List Which character this character on top of
Characters can go inside this object Objects (containers) Selection Only Objects characters can get into

General Tasks:

Name Command Description Default Text
Player Movement {[go/walk/move/run] {to {the}}} %direction% Controls the north, south, up, down, in, out commands  %CharacterName% move[27] %LCase[%direction%]%.
Go Inside Object [move/go/get] [in{to/side}] %object%
enter %object%
Enter object that has "characters can go inside this object" property  %CharacterName% step[28] inside %TheObject[%object%]%.
Get Out of Object [stand/get/move/go] out {of} %object%
exit %object%
leave %object%
If character is inside an object, get out  %CharacterName% get[29] out of %TheObject[%object%]%.
Climb objects [climb/clamber/go] {up/down/on} %object%
[move/walk] [up/down/on] %object%
Try to climb up something  %CharacterName% can't climb %TheObject[%object%]%.

Attacking

Basic fighting, note that the Battle System from ADRIFT 4 is not implimented in ADRIFT 5 and probably wont be for some time.

Name Command Description Default Text
Attack character [attack/hit/kick/kill] %character% Override with a specific task to make a character attackable I don't think %CharacterName[%character%]% would appreciate that very much.
Attack character with object [attack/hit/kick/kill] %character% [with/using] %object% Override with a specific tasks to make a character attackable with specific objects I don't think %CharacterName[%character%]% would appreciate that very much.


<<< FoldersMain PageText Boxes >>>