FutureMUD Function Reference

Absorbs a live NPC into an abstract field herd.

Adjusts one of a field's agriculture scores.

Creates an agriculture field in a location, returning null if one already exists or no profile is available.

Creates an agriculture field in a location with the specified profile.

Creates an agriculture field in a location with the specified profile.

Deletes an agriculture field.

Draws live NPC livestock from an abstract field herd.

Returns the agriculture field in a location, or null if there is none.

Returns one of a field's agriculture scores.

Sets one of a field's agriculture scores.

Starts an agriculture project with no target.

Starts an agriculture project with a dynamic target.

Invokes direct storyteller attention by id and returns true if the invocation was accepted.

Invokes direct storyteller attention by name and returns true if the invocation was accepted.

Invokes direct storyteller attention by id and returns true if the invocation was accepted.

Invokes direct storyteller attention by name and returns true if the invocation was accepted.

Returns one boxing point total per side, counting only landed undefended hits to the head or torso.

Returns the arena rating for a character in a specific combatant class.

Returns the arena rating for a character in a specific combatant class.

The function returns true if the given character is currently participating in an arena battle.

The function returns true if the given character and target are currently participating in an arena battle and are on the opposing team.

The function returns true if the given character and target are currently participating in an arena battle and are on the same team.

Adds a room to a character's Territory effect, creating the effect if necessary. Optional text flags tag the room for later AI checks. Errors if the character or room is null; otherwise returns true.

Adds a room to a character's Territory effect, creating the effect if necessary. Optional text flags tag the room for later AI checks. Errors if the character or room is null; otherwise returns true.

Adds a room to a character's Territory effect, creating the effect if necessary. Optional text flags tag the room for later AI checks. Errors if the character or room is null; otherwise returns true.

Adds a room to a character's Territory effect, creating the effect if necessary. Optional text flags tag the room for later AI checks. Errors if the character or room is null; otherwise returns true.

Checks whether a room is in a character's Territory effect and, when flags are supplied, whether all supplied flags are present. Errors if the character or room is null; returns false if the character has no territory effect or any flag is missing.

Checks whether a room is in a character's Territory effect and, when flags are supplied, whether all supplied flags are present. Errors if the character or room is null; returns false if the character has no territory effect or any flag is missing.

Checks whether a room is in a character's Territory effect and, when flags are supplied, whether all supplied flags are present. Errors if the character or room is null; returns false if the character has no territory effect or any flag is missing.

Checks whether a room is in a character's Territory effect and, when flags are supplied, whether all supplied flags are present. Errors if the character or room is null; returns false if the character has no territory effect or any flag is missing.

Returns the character's current wild animal herd role as text, or 'None' if they are not in a herd. Errors if the character parameter is null.

Parses area text into base units using the unit manager. Returns an error if the text is not a valid unit expression.

Parses fluid volume text into base units using the unit manager. Returns an error if the text is not a valid unit expression.

Parses length text into base units using the unit manager. Returns an error if the text is not a valid unit expression.

Parses mass text into base units using the unit manager. Returns an error if the text is not a valid unit expression.

Returns the higher of two numbers.

Returns the lower of two numbers.

Returns a random whole number between the supplied minimum and maximum bounds. This is the FutureProg random helper for simple integer-range rolls.

Removes a named or numbered event hook from a perceivable target. Returns false if the target, hook argument, hook lookup, or perceivable conversion fails; otherwise returns the result of the target's hook removal.

Removes a named or numbered event hook from a perceivable target. Returns false if the target, hook argument, hook lookup, or perceivable conversion fails; otherwise returns the result of the target's hook removal.

Returns true when both race references point to the same race object. Null races simply compare as not the same.

Parses temperature text into base units using the unit manager. Returns an error if the text is not a valid unit expression.

Formats a base-unit area value as player-facing text using the unit manager. This is the inverse of areafromtext for builder scripts that need readable units.

Formats a base-unit fluid volume value as player-facing text using the unit manager. This is the inverse of fluid volumefromtext for builder scripts that need readable units.

Formats a base-unit length value as player-facing text using the unit manager. This is the inverse of lengthfromtext for builder scripts that need readable units.

Formats a base-unit mass value as player-facing text using the unit manager. This is the inverse of massfromtext for builder scripts that need readable units.

Formats a base-unit temperature value as player-facing text using the unit manager. This is the inverse of temperaturefromtext for builder scripts that need readable units.

Formats a base-unit volume value as player-facing text using the unit manager. This is the inverse of volumefromtext for builder scripts that need readable units.

Attempts to treat a perceiver, perceivable, or collection item as an item. Returns null when the supplied value is not an item.

Attempts to treat a perceiver, perceivable, or collection item as an item. Returns null when the supplied value is not an item.

Attempts to treat a perceiver, perceivable, or collection item as an item. Returns null when the supplied value is not an item.

Parses text into a number. If parsing fails, the result is 0.

Parses text into a number, returning the supplied fallback number when parsing fails.

Converts a number to cardinal words, such as one hundred and five.

Converts a number to ordinal text, such as 1st or 22nd.

Converts a number to ordinal words, such as one hundred and fifth.

Converts the supplied value to text using the standard FutureProg conversion rules.

Converts the supplied value to text using the standard FutureProg conversion rules.

Converts the supplied value to text using the standard FutureProg conversion rules.

Parses volume text into base units using the unit manager. Returns an error if the text is not a valid unit expression.

Looks up a celestial object by ID in the supplied room or zone and returns its current elevation above or below the horizon in radians. Positive values are above the horizon. Returns 0 if the zone or celestial object cannot be found.

Looks up a celestial object by ID in the supplied room or zone and returns its current elevation above or below the horizon in radians. Positive values are above the horizon. Returns 0 if the zone or celestial object cannot be found.

Looks up a celestial object by ID in the supplied room or zone and returns the same descriptive position text used by the celestial system. Returns an empty string if the zone or celestial object cannot be found.

Looks up a celestial object by ID in the supplied room or zone and returns the same descriptive position text used by the celestial system. Returns an empty string if the zone or celestial object cannot be found.

Looks up the first planetary moon associated with the supplied room's zone or zone and returns its current phase text. Returns an empty string if the zone or moon cannot be found.

Looks up the first planetary moon associated with the supplied room's zone or zone and returns its current phase text. Returns an empty string if the zone or moon cannot be found.

Returns the next deterministic full moon for a lunar celestial. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the next deterministic full moon for a lunar celestial. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the next deterministic full moon for a lunar celestial. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the next deterministic full moon for a lunar celestial. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the next deterministic lunar conjunction/new moon for a lunar celestial. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the next deterministic lunar conjunction/new moon for a lunar celestial. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the next deterministic lunar conjunction/new moon for a lunar celestial. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the next deterministic lunar conjunction/new moon for a lunar celestial. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the next time a solar celestial crosses the supplied ecliptic longitude in degrees. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the next time a solar celestial crosses the supplied ecliptic longitude in degrees. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the next time a solar celestial crosses the supplied ecliptic longitude in degrees. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the next time a solar celestial crosses the supplied ecliptic longitude in degrees. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the next sunrise for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunrise. Returns Never if no event is found.

Returns the next sunrise for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunrise. Returns Never if no event is found.

Returns the next sunrise for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunrise. Returns Never if no event is found.

Returns the next sunrise for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunrise. Returns Never if no event is found.

Returns the next sunset for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunset. Returns Never if no event is found.

Returns the next sunset for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunset. Returns Never if no event is found.

Returns the next sunset for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunset. Returns Never if no event is found.

Returns the next sunset for a solar celestial at the supplied room or zone. The optional occurrence parameter returns the nth next sunset. Returns Never if no event is found.

Returns the next deterministic visible-crescent approximation after sunset using geometric thresholds only. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the next deterministic visible-crescent approximation after sunset using geometric thresholds only. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the next deterministic visible-crescent approximation after sunset using geometric thresholds only. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the next deterministic visible-crescent approximation after sunset using geometric thresholds only. The optional occurrence parameter returns the nth next occurrence. Returns Never if no event is found.

Returns the current physical body id for this actor instance, or 0 if no body is available.

Returns the durable identity id for a character, shared by all simultaneous bodies.

Returns the CharacterInstances row id for this active body, or 0 for legacy actors without an instance row.

This function allows you to roll a check against a trait at a defined difficulty for a character, and see the result. The return values are -3 = Major Fail, -2 = Fail, -1 = Minor Fail, 1 = Minor Pass, 2 = Pass, 3 = Major Pass

Returns a list of direction commands between the character and the target, if one exists.

Returns a list of direction commands between the character and the target, if one exists, but ignores any doors (open, closed, locked or otherwise).

Returns a list of direction commands between the character and the target, if one exists, but respects any closed doors as untraversable.

Returns a list of direction commands between the character and the target, if one exists, but respects any locked and closed doors as untraversable.

This function returns the current trait value of the selected trait on the specified person

This function returns the trait cap of the selected trait on the specified person

Gives an accent to a character at automatic. Returns true if given, false if already had it.

Gives a knowledge to a character. Returns true if given, false if already had it.

Gives a merit to a character. Returns true if given, false if already had it.

Gives a trait (skill or attribute) to a player. Uses the opening value as if the trait had branched (for skills) or minimum value (for attributes). Returns the value of the trait

Gives a trait (skill or attribute) to a player with the specified value. If they already have the trait, sets the value if it is higher. Returns the value of the trait

Gives a trait improvement tick to a trait. This is as if the player had rolled an improvement naturally. Returns the new value.

This function tells you if the person you specify, which can be a character, chargen or NPC template, is an admin

Returns true when the character's race descends from one of the stock non-humanoid animal body families.

Returns all of the Actors (PC and NPC characters) that are loaded into the game.

Returns all of the PC characters that are online.

Returns all of the NPC characters that are loaded into the game.

Takes a knowledge from a character. Returns true if taken, false if they didn't have it.

Takes a merit from a character. Returns true if taken, false if didn't have it.

Returns true if both character variables represent the same durable character identity, even if they are different active bodies.

Returns true if both arguments are the same active physical actor/body, and false for another simultaneous body belonging to the same identity.

Sets the value of a trait (skill or attribute) for a player with the specified value. Gives them the trait if they don't have it but can lower the value if they already have it but it is higher than the value you specify. Returns the value of the trait

Spawns a secondary body instance from one of a loaded character's owned dormant forms. The returned character is the new physical actor, or the function errors with a builder-facing reason.

Spawns a secondary body instance from one of a loaded character's owned dormant forms. The returned character is the new physical actor, or the function errors with a builder-facing reason.

Spawns a secondary body instance from one of a loaded character's owned dormant forms. The returned character is the new physical actor, or the function errors with a builder-facing reason.

Spawns a secondary body instance from one of a loaded character's owned dormant forms. The returned character is the new physical actor, or the function errors with a builder-facing reason.

Spawns a secondary body instance from one of a loaded character's owned dormant forms. For ai/scriptai modes, the final text argument attaches ready AI routines by id or name.

Spawns a secondary body instance from one of a loaded character's owned dormant forms. For ai/scriptai modes, the final text argument attaches ready AI routines by id or name.

Teleports a character to the ground level (or closest layer) in a new room. Returns false if the teleportation fails (if invalid character, room, or layer is specified).

Teleports a character to the specified layer in a new room. Returns false if the teleportation fails (if invalid character, room, or layer is specified).

Teleports a character and all their followers/drag targets to the ground level (or closest layer) in a new room. Returns false if the teleportation fails (if invalid character, room, or layer is specified).

Teleports a character and all their followers/drag targets to the specified layer in a new room. Returns false if the teleportation fails (if invalid character, room, or layer is specified).

Teleports a character and all their followers/drag targets to the ground level (or closest layer) in a new room, with no echoes. Returns false if the teleportation fails (if invalid character, room, or layer is specified).

Teleports a character and all their followers/drag targets to the specified layer in a new room, with no echoes. Returns false if the teleportation fails (if invalid character, room, or layer is specified).

Teleports a character to the ground level (or closest layer) in a new room, with no echoes. Returns false if the teleportation fails (if invalid character, room, or layer is specified).

Teleports a character to the specified layer in a new room, with no echoes. Returns false if the teleportation fails (if invalid character, room, or layer is specified).

Adds an effect to a character that gives a bonus to a trait. You also supply a reference bit of text. Each character can only have one effect with a specific reference, so you can use this to ensure that bonuses don't get stacked. You also use it to remove the specific bonus later. Returns the effect that it adds.

Adds an effect to a character that gives a bonus to a trait. You also supply a reference bit of text. Each character can only have one effect with a specific reference, so you can use this to ensure that bonuses don't get stacked. You also use it to remove the specific bonus later. Returns the effect that it adds.

Adds an effect to a character that gives a bonus to a trait. You also supply a reference bit of text. Each character can only have one effect with a specific reference, so you can use this to ensure that bonuses don't get stacked. You also use it to remove the specific bonus later. Returns the effect that it adds.

Adds an effect to a character that gives a bonus to a trait. You also supply a reference bit of text. Each character can only have one effect with a specific reference, so you can use this to ensure that bonuses don't get stacked. You also use it to remove the specific bonus later. Returns the effect that it adds.

Adds an effect to a character that gives a bonus to a trait. You also supply a reference bit of text. Each character can only have one effect with a specific reference, so you can use this to ensure that bonuses don't get stacked. You also use it to remove the specific bonus later by setting the trait/reference combination to zero bonus. Returns the effect that it adds.

Adds an effect to a character that gives a bonus to a trait. You also supply a reference bit of text. Each character can only have one effect with a specific reference, so you can use this to ensure that bonuses don't get stacked. You also use it to remove the specific bonus later. Returns the effect that it adds.

This function returns the ID of the supplied character's intrinsic characteristic for the supplied definition. E.g. If you supplied the ID number of the colour characteristic, you might get the ID 435 as a return value.

This function returns the ID of the supplied items's intrinsic characteristic for the supplied definition. E.g. If you supplied the ID number of the colour characteristic, you might get the ID 435 as a return value.

This function returns the ID of the supplied character's intrinsic characteristic for the supplied definition. E.g. If you supplied the ID number of the colour characteristic, you might get the ID 435 as a return value.

This function returns the ID of the supplied items's intrinsic characteristic for the supplied definition. E.g. If you supplied the ID number of the colour characteristic, you might get the ID 435 as a return value.

This function returns the name of the supplied character's intrinsic characteristic for the supplied definition. E.g. If you supplied the ID number of the eyecolour characteristic, you might get the 'emerald green' as a return value.

This function returns the name of the supplied items's intrinsic characteristic for the supplied definition. E.g. If you supplied the ID number of the colour characteristic, you might get the 'hot pink' as a return value.

This function returns the name of the supplied character's intrinsic characteristic for the supplied definition. E.g. If you supplied the ID number of the eyecolour characteristic, you might get the 'emerald green' as a return value.

This function returns the name of the supplied items's intrinsic characteristic for the supplied definition. E.g. If you supplied the ID number of the colour characteristic, you might get the 'hot pink' as a return value.

This function allows you to return the text value of a specified characteristic of a character, chargen or item. It returns the same result as if you had used $name in a description.

This function allows you to return the text value of a specified characteristic of a character, chargen or item. It returns the same result as if you had used $name in a description. This version returns the true value of a characteristic, unhindered by the lens of a perceiver.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target to a random value selected from the profile you supply. Returns true if successful.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target to a random value selected from the profile you supply. Returns true if successful.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target to a random value selected from the profile you supply. Returns true if successful.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target to a random value selected from the profile you supply. Returns true if successful.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target to a random value selected from the profile you supply. Returns true if successful.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target to a random value selected from the profile you supply. Returns true if successful.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target to a random value selected from the profile you supply. Returns true if successful.

Sets the intrinsic characteristic value for the characteristic definition on the supplied target to a random value selected from the profile you supply. Returns true if successful.

Returns true if a character can mount the mount.

Returns true if the specified form is currently visible to the owning character.

Returns true if the specified form is currently visible to the owning character.

Returns true if the character can voluntarily switch to the specified form right now.

Returns true if the character can voluntarily switch to the specified form right now.

Clears all prog-created death backups from a character.

Clears a prog-created death backup for a specific form.

Clears a prog-created death backup for a specific form.

Clears a form voluntary-switch eligibility prog and returns true on success.

Clears a form voluntary-switch eligibility prog and returns true on success.

Clears a form full description pattern and returns true on success.

Clears a form full description pattern and returns true on success.

Clears a form short description pattern and returns true on success.

Clears a form short description pattern and returns true on success.

Clears a form transformation echo so the default echo is used.

Clears a form transformation echo so the default echo is used.

Clears a form visibility prog and returns true on success.

Clears a form visibility prog and returns true on success.

Clears a form denial-message prog and returns true on success.

Clears a form denial-message prog and returns true on success.

Returns the alias of the character's current form.

Returns the body id of the character's current form.

Forceably removes a character from their mount. Does not do any echoes.

Ensures a keyed form exists for the character and returns its body id.

Ensures a keyed form exists for the character and returns its body id.

Ensures a keyed form exists for the character and returns its body id.

Attempts a scripted form switch that bypasses voluntary gating but still enforces structural validity.

Attempts a scripted form switch that bypasses voluntary gating but still enforces structural validity.

Returns true if a character has any applicable death backup.

Returns true if a character has an applicable death backup for a specific form.

Returns true if a character has an applicable death backup for a specific form.

Returns true if the character owns a form with the specified alias or body id.

Returns true if the character owns a form with the specified alias or body id.

Kills the specified character, and optionally leaves a corpse. Returns the corpse as an item.

Makes a character mount an available mount. Returns true if successful. Does handle echoes.

Randomises a valid full description pattern for a form and returns true on success.

Randomises a valid full description pattern for a form and returns true on success.

Randomises a valid short description pattern for a form and returns true on success.

Randomises a valid short description pattern for a form and returns true on success.

Readies a form as a death backup with default priority, sleeve remains context, and default transfer echoes.

Readies a form as a death backup with sleeve remains context and default transfer echoes.

Readies a form as a death backup with default transfer echoes.

Readies a form as a death backup with custom transfer echoes.

Readies a form as a death backup with default priority, sleeve remains context, and default transfer echoes.

Readies a form as a death backup with sleeve remains context and default transfer echoes.

Readies a form as a death backup with default transfer echoes.

Readies a form as a death backup with custom transfer echoes.

Sets a form alias and returns true on success.

Sets a form alias and returns true on success.

Sets whether a form permits voluntary switching and returns true on success.

Sets whether a form permits voluntary switching and returns true on success.

Sets a form voluntary-switch eligibility prog and returns true on success.

Sets a form voluntary-switch eligibility prog and returns true on success.

Sets a form voluntary-switch eligibility prog and returns true on success.

Sets a form voluntary-switch eligibility prog and returns true on success.

Sets a form full description pattern and returns true on success.

Sets a form full description pattern and returns true on success.

Sets a form short description pattern and returns true on success.

Sets a form short description pattern and returns true on success.

Sets a form sort order and returns true on success.

Sets a form sort order and returns true on success.

Sets a form transformation echo and returns true on success.

Sets a form transformation echo and returns true on success.

Sets a form trauma mode and returns true on success.

Sets a form trauma mode and returns true on success.

Sets a form trauma mode and returns true on success.

Sets a form trauma mode and returns true on success.

Sets a form visibility prog and returns true on success.

Sets a form visibility prog and returns true on success.

Sets a form visibility prog and returns true on success.

Sets a form visibility prog and returns true on success.

Sets a form voluntary-switch denial-message prog and returns true on success.

Sets a form voluntary-switch denial-message prog and returns true on success.

Sets a form voluntary-switch denial-message prog and returns true on success.

Sets a form voluntary-switch denial-message prog and returns true on success.

Attempts a voluntary form switch, including ordinary player-facing feedback, and returns true on success.

Attempts a voluntary form switch, including ordinary player-facing feedback, and returns true on success.

Returns an error message about why a character cannot mount the mount.

Returns the reason why a character cannot voluntarily switch to the specified form.

Returns the reason why a character cannot voluntarily switch to the specified form.

Returns the amount of the specified chargen resources (karma, RPP, BP, etc) that an account has

This function gives (or takes if you use a negative number) a specified amount of chargen resource (Karma, RPP, BP, etc) to an account. It returns the new amount of resource that account has after the change.

This function appoints a character to a position in a clan they're already in. It returns false if the character was not in the clan.

This function adds a character to a clan. It returns false if the character was already in the clan.

This function adds a character to a clan. It returns false if the character was already in the clan.

This function adds a character to a clan at the default rank. It returns false if the character was already in the clan.

Checks whether two characters share at least one clan membership after optionally excluding a clan or collection of clans. Use the exclusion overloads to ignore common public clans. Errors if either character is null; returns false if there is no shared qualifying clan.

Checks whether two characters share at least one clan membership after optionally excluding a clan or collection of clans. Use the exclusion overloads to ignore common public clans. Errors if either character is null; returns false if there is no shared qualifying clan.

Checks whether two characters share at least one clan membership after optionally excluding a clan or collection of clans. Use the exclusion overloads to ignore common public clans. Errors if either character is null; returns false if there is no shared qualifying clan.

Checks whether a character is a member of a clan, optionally constrained by minimum rank, appointment, or rank and paygrade. Errors if required character, clan, rank, paygrade, or appointment inputs are null; returns false when the membership requirement is not met.

Checks whether a character is a member of a clan, optionally constrained by minimum rank, appointment, or rank and paygrade. Errors if required character, clan, rank, paygrade, or appointment inputs are null; returns false when the membership requirement is not met.

Checks whether a character is a member of a clan, optionally constrained by minimum rank, appointment, or rank and paygrade. Errors if required character, clan, rank, paygrade, or appointment inputs are null; returns false when the membership requirement is not met.

Checks whether a character is a member of a clan, optionally constrained by minimum rank, appointment, or rank and paygrade. Errors if required character, clan, rank, paygrade, or appointment inputs are null; returns false when the membership requirement is not met.

Checks whether the first character outranks the second in the supplied clan. Errors if either character or the clan is null; returns false if either character is not a valid member in that clan.

Checks whether the first character outranks or is at the same rank level as the second in the supplied clan. Errors if either character or the clan is null; returns false if either character is not a valid member in that clan.

Looks up an appointment within a clan by ID or name. Errors if the clan is null; returns null if no appointment matches.

Looks up an appointment within a clan by ID or name. Errors if the clan is null; returns null if no appointment matches.

Looks up a clan by ID or name. Returns null if no clan matches.

Looks up a clan by ID or name. Returns null if no clan matches.

Looks up a paygrade within a clan by ID, name, or abbreviation. Errors if the clan is null; returns null if no paygrade matches.

Looks up a paygrade within a clan by ID, name, or abbreviation. Errors if the clan is null; returns null if no paygrade matches.

Looks up a rank within a clan by ID or name. Errors if the clan is null; returns null if no rank matches.

Looks up a rank within a clan by ID or name. Errors if the clan is null; returns null if no rank matches.

Returns the current time-of-day band for a room or zone, such as night or dawn. A null argument falls back to Night.

Returns the current time-of-day band for a room or zone, such as night or dawn. A null argument falls back to Night.

Returns an empty character collection.

Returns true if the supplied collection contains at least one item.

Returns a new collection with the supplied item appended to the end.

Returns the item at the zero-based index, or null if the index is outside the collection.

Returns a new collection with the second collection appended to the first collection.

Returns true if the supplied collection contains the supplied item. Text comparison ignores case.

Returns the number of items in the supplied collection.

Returns a new collection with duplicate values removed, keeping the first occurrence of each value.

Returns true if the supplied collection has no items.

Returns the first item in the supplied collection, or null if the collection is empty.

Returns the zero-based index of the first matching item in the supplied collection, or -1 if absent. Text comparison ignores case.

Returns true if the supplied zero-based index points at an item in the collection.

Returns the last item in the supplied collection, or null if the collection is empty.

Returns a new collection with the supplied item prepended to the start.

Returns a new collection containing up to count items from the supplied zero-based index.

Returns a new collection with the supplied collection's items in reverse order.

Returns a new collection with the supplied collection's items in random order.

Returns a new collection excluding up to count items from the start of the supplied collection.

Returns a new collection containing up to count items from the start of the supplied collection.

Returns a new collection with the item at the zero-based index omitted. Invalid indexes return a copy of the original collection.

This function allows you to test whether a given item is in a collection. True if the collection contains the item.

This function returns the element at the specified index of a collection, or null if an incorrect index is specified. The return type depends on the return type of the collection. You may need to convert the result. See CONVERT function.

This function returns the zero-based index of a specified item in the collection, if present. If not present it returns -1.

Starts a combat that executes progs when various things happen.

Appends text to a file on the current computer owner and returns true if a writable file system was available.

Clears the currently active terminal session by writing a fresh blank screen and returns true if a session was available.

Returns true if the named file exists on the current computer owner.

Returns the file names available on the current computer owner.

Kills a process on the current owner and returns true if that process was ended.

Launches a computer program on the current owner and returns its process id, or 0 if launch failed.

Reads the full text contents of a file from the current computer owner.

Suspends the current computer program until the connected terminal user types a line of input, then returns that line as text.

Suspends the current computer program until the named signal source on the execution host item emits a non-zero signal, then returns that numeric signal value.