Help Functions

From FiranMUX

Jump to: navigation, search

This is the basic template for function help files.

Syntax

FUNCTION: <function name>

Syntax: <syntax>

<function description>

See also help on: <x-refs> See also news on: <x-refs> See also wizhelp on: x-refs>

Catagories: <catagories separated by |>

NOTE: Only x-ref lines are needed for which there are matching x-ref type files.

Sample

FUNCTION: ac_create

Syntax: ac_create(<object>,<account-type>,<amount>)

This function prepares an object to be used with ac_adjust or ac_transfer on an account-type-by-account-type basis. It requires an initial amount to be specified for the number of account-type units in the account, which may be zero.

See also help on: ac_adjust, ac_transfer, ac_parent, @account/create

Catagories: accounts|functions|objects

Personal tools