Difference between revisions of "The Standard Library"

From ADRIFT 5 Manual Wiki
Jump to: navigation, search
m
Line 8: Line 8:
 
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.
 
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.
 
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 contents of each of these folders is explained in the following sections.  

Revision as of 04:48, 21 December 2011

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'.
%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.

IconWarning.png UNDER CONSTRUCTION - THIS INFORMATION IS INCOMPLETE.

Tasks - Uncategorised

There is currently only one task in this folder.

Command Action Default Text
Inventory Lists what the player is currently wearing & holding You are wearing %ListWorn[%Player%]%, and are carrying %ListHeld[%Player%]%.

Properties

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

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.

Command Action Default Text
drop %objects% object in inventory is put on the ground Ok, %CharacterName% put[1] down %TheObjects[%objects%]%.
get %objects% pick up a dynamic object from current location Ok, %CharacterName% pick[2] up %TheObjects[%objects%]%.
get %objects% from %object% Take an object that is inside or on top of another object Ok, %CharacterName% take[3] %TheObjects[%objects%]% from %TheObject[%object2%]%.
give %objects% to %character%
give %character% %objects%
object in inventory goes to another characters inventory  %CharacterName% hand[4] %CharacterName[%character%, target]% %TheObject[%objects%]%.
offer %objects% to %character%
offer %character% %objects%
object in inventory goes to another characters inventory  %CharacterName% hand[5] %CharacterName[%character%, target]% %TheObject[%objects%]%.
pick up %objects%
pick %objects% up
pick up a dynamic object from current location Ok, %CharacterName% pick[6] up %TheObjects[%objects%]%.
pick up %objects% from %object%
pick %objects% up from %object%
Take an object that is inside or on top of another object Ok, %CharacterName% take[7] %TheObjects[%objects%]% from %TheObject[%object2%]%.
put down %objects%
put %objects% down
object in inventory is put on the ground Ok, %CharacterName% put[8] down %TheObjects[%objects%]%.
put %objects% in %object% object in inventory is put into a container  %CharacterName% put[9] %TheObjects[%objects%]% inside %TheObject[%object2%]%.
put %objects% on %object% object in inventory is put onto a surface Ok, %CharacterName% put[10] %TheObjects[%objects%]% on top of %TheObject[%object2%]%.
remove %objects% from %object% Take an object that is inside or on top of another object Ok, %CharacterName% take[11] %TheObjects[%objects%]% from %TheObject[%object2%]%.
take %objects% pick up a dynamic object from current location Ok, %CharacterName% pick[12] up %TheObjects[%objects%]%.
take %objects% from %object% Take an object that is inside or on top of another object Ok, %CharacterName% take[13] %TheObjects[%objects%]% from %TheObject[%object2%]%.

Character Position

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

Command Action Default Text

Push and Pull

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

Command Action Default Text

Conversation

Talking to another character.

Command Action Default Text

Open and Close

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

Command Action Default Text

Look and Examine

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

Command Action Default Text

Wear and Remove

Put on an item of clothing, or take it off.

Command Action Default Text

Eat and Drink

Properties determine if an object can be eaten or drunk.

Command Action Default Text

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.

Command Action Default Text

Attacking

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

Command Action Default Text