%object%.Capacity function

From ADRIFT 5 Manual Wiki
Revision as of 04:27, 11 January 2013 by Saabie (Talk | contribs) (formatting)

Jump to: navigation, search

The Capacity function returns the maximum number of tiny objects that can fit inside of a container object, as an integer.

Requirements

The "Object is a container" and "...and the container can hold" properties of the object must be selected to be able to use this function.

You can check this using the object restriction:

[object] [must] [have property] [...and the container can hold]

Properties

The "...and the container can hold" property of the object has both a number entry field and a drop-down list containing the five size ranges defined in the Object size value-list property. The number returned by this function will be the number in the entry field multiplied by the value corresponding to the size selected in the drop-down list. If [12][Small] is entered, then this indicates that the player is able to carry 12 small objects, or the equivalent volume in objects of other sizes.

File:PropertyCapacity.jpg

The "...and the container can hold" property is defined to be of type "Integer - Object Size".

The "Object size" object property defines the values corresponding to each of the object sizes.

PropertyDialogObjectSize.jpg

  • ADRIFT does not specify the units used for these values, they are completely arbitrary values.
If you wanted to print these values with units you could use cubic centimetres, litres, or even cubic inches if your game is set in the past.
  • You can change the values in the "Object size" value list if you need a greater or smaller range of object sizes.
The default is for each size to have three times the volume of the next smallest.

How to use

This function simply returns the value of the maximum bulk the object can hold as a single integer value that can be inserted into text, or used as part of an expression in a restriction or action. No further functions can be appended to this function.

Examples

  • Object7.Capacity
The maximum bulk that the specific object with the key "Object7" can hold.
  • %object%.Capacity
The maximum bulk that the referenced object, in a task with an %object% reference, can hold.


<<< ListDescriptionObject FunctionsSurfaceHold >>>