FutureMUD Function Reference
ADDHEALINGEFFECT
boolean addhealingeffect(perceivable perceivable, number multiplier, number stages, number progid, timespan duration)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable to whom the healing effect is being added |
multiplier | number | the healing multiplier for the effect |
stages | number | the number of difficulty stages to stage the healing difficulty checks by |
progid | number | the id of the prog to whether the effect applies |
duration | timespan | the duration of the effect |
ADDHEALINGEFFECT
boolean addhealingeffect(perceivable perceivable1, number number1, number number11, text text1, timespan timespan1)
Parameter | Variable Type | Parameter Help |
perceivable1 | perceivable | this parameter has no help information. |
number1 | number | this parameter has no help information. |
number11 | number | this parameter has no help information. |
text1 | text | this parameter has no help information. |
timespan1 | timespan | this parameter has no help information. |
This function has no general help information.
ADDHOOK
boolean addhook(perceivable perceivable, number hookid)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable for whom you want to install a hook |
hookid | number | the id of the hook that you want to install. |
This function installs a 'hook' on a perceivable. See in game help for hooks for more info.
ADDHOOK
boolean addhook(perceivable perceivable, text hookname)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable for whom you want to install a hook |
hookname | text | the name of the hook that you want to install. |
This function installs a 'hook' on a perceivable. See in game help for hooks for more info.
ADDINVISEFFECT
boolean addinviseffect(perceivable perceivable1, number number1)
Parameter | Variable Type | Parameter Help |
perceivable1 | perceivable | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
ADDINVISEFFECT
boolean addinviseffect(perceivable perceivable1, text text1)
Parameter | Variable Type | Parameter Help |
perceivable1 | perceivable | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
ADDITEMTOOUTFIT
boolean additemtooutfit(outfit outfit1, item item1)
Parameter | Variable Type | Parameter Help |
outfit1 | outfit | this parameter has no help information. |
item1 | item | this parameter has no help information. |
This function has no general help information.
ADDITEMTOOUTFIT
boolean additemtooutfit(outfit outfit1, item item1, item item11)
Parameter | Variable Type | Parameter Help |
outfit1 | outfit | this parameter has no help information. |
item1 | item | this parameter has no help information. |
item11 | item | this parameter has no help information. |
This function has no general help information.
ADDITEMTOOUTFIT
boolean additemtooutfit(outfit outfit1, item item1, item item11, text text1)
Parameter | Variable Type | Parameter Help |
outfit1 | outfit | this parameter has no help information. |
item1 | item | this parameter has no help information. |
item11 | item | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
ADDITEMTOOUTFIT
boolean additemtooutfit(outfit outfit1, item item1, text text1)
Parameter | Variable Type | Parameter Help |
outfit1 | outfit | this parameter has no help information. |
item1 | item | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
ADDTATTOO
boolean addtattoo(character character, number tattooid, text bodypart, character tattooist, number tattooistskill, number completion)
Parameter | Variable Type | Parameter Help |
character | character | the character who is getting the tattoo |
tattooid | number | the id number of the tattoo template to apply |
bodypart | text | the name of the bodypart to install the tattoo on |
tattooist | character | the tattooist who is responsible for the tattoo. can be null |
tattooistskill | number | the skill of the tattooist. if it is null, checks the tattooist's skill |
completion | number | the completion percentage between 0.0 and 1.0 |
This command attempts to add the specified tattoo to a character. Returns true if it was successful.
ADDTERRITORY
boolean addterritory(character character1, location location1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
location1 | location | this parameter has no help information. |
This function has no general help information.
ADDTERRITORY
boolean addterritory(character character1, location location1, text text1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
location1 | location | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
ADDTERRITORY
boolean addterritory(character character1, location location1, text text1, text text11)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
location1 | location | this parameter has no help information. |
text1 | text | this parameter has no help information. |
text11 | text | this parameter has no help information. |
This function has no general help information.
ADDTERRITORY
boolean addterritory(character character1, location location1, text text1, text text11, text text12)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
location1 | location | this parameter has no help information. |
text1 | text | this parameter has no help information. |
text11 | text | this parameter has no help information. |
text12 | text | this parameter has no help information. |
This function has no general help information.
ALLCRIMES
crime collection allcrimes(character character, legalauthority authority)
Parameter | Variable Type | Parameter Help |
character | character | the character to fetch crimes for |
authority | legalauthority | the authority to check crimes in, or if null, all authorities |
Returns a list of all the crimes a character has committed in the specified authority (or authorities)
APPROVEOVERLAY
boolean approveoverlay(overlaypackage package, character builder)
Parameter | Variable Type | Parameter Help |
package | overlaypackage | the package that you want to approve |
builder | character | the builder who is approving the package, or null for 'system' |
Approves the specified overlay package as ready for use. Returns true if successful
APPROVEOVERLAY
boolean approveoverlay(overlaypackage package, character builder, text comment)
Parameter | Variable Type | Parameter Help |
package | overlaypackage | the package that you want to approve |
builder | character | the builder who is approving the package, or null for 'system' |
comment | text | a comment for the builder approval log |
Approves the specified overlay package as ready for use. Returns true if successful
AREAFROMTEXT
number areafromtext(text text1)
Parameter | Variable Type | Parameter Help |
text1 | text | this parameter has no help information. |
This function has no general help information.
ATTACH
boolean attach(item item1, item item11)
Parameter | Variable Type | Parameter Help |
item1 | item | this parameter has no help information. |
item11 | item | this parameter has no help information. |
This function has no general help information.
BESTKEYWORD
text bestkeyword(character source, character target)
Parameter | Variable Type | Parameter Help |
source | character | the source for whom you want to identify the keyword |
target | character | the target whose keyword you want to identify |
This function allows you to determine what the 'best' keyword is for a target from a source. In this case, best implies a unique keyword that will allow the source to target the target through all regular commands.
BESTKEYWORD
text bestkeyword(character source, item target)
Parameter | Variable Type | Parameter Help |
source | character | the source for whom you want to identify the keyword |
target | item | the target whose keyword you want to identify |
This function allows you to determine what the 'best' keyword is for a target from a source. In this case, best implies a unique keyword that will allow the source to target the target through all regular commands. This version of the command considers both the player's inventory and the room contents.
BESTKEYWORDINVENTORY
text bestkeywordinventory(character source, item target)
Parameter | Variable Type | Parameter Help |
source | character | the source for whom you want to identify the keyword |
target | item | the target whose keyword you want to identify |
This function allows you to determine what the 'best' keyword is for a target from a source. In this case, best implies a unique keyword that will allow the source to target the target through all regular commands. This version of the command considers only the player's inventory and not the room contents.
BESTKEYWORDROOM
text bestkeywordroom(character source, item target)
Parameter | Variable Type | Parameter Help |
source | character | the source for whom you want to identify the keyword |
target | item | the target whose keyword you want to identify |
This function allows you to determine what the 'best' keyword is for a target from a source. In this case, best implies a unique keyword that will allow the source to target the target through all regular commands. This version of the command considers only the room contents and not the player's inventory.
BWTEXTTABLE
text bwtexttable(text collection headers, text collection values, number width)
Parameter | Variable Type | Parameter Help |
headers | text collection | a collection of text values to use as the headers of the table |
values | text collection | a collection of text values, each of which is a row, with columns separated by the tab (\t) character |
width | number | the width of the table |
This function displays a plain 'text table', essentially an ASCII representation of a table. The number of columns in the header MUST match the number of columns in each row.
BWTEXTTABLE
text bwtexttable(text headers, text collection values, number width)
Parameter | Variable Type | Parameter Help |
headers | text | text with values separated by tab characters (\t) to use as the headers of the table |
values | text collection | a collection of text values, each of which is a row, with columns separated by the tab (\t) character |
width | number | the width of the table |
This function displays a plain 'text table', essentially an ASCII representation of a table. The number of columns in the header MUST match the number of columns in each row.
CANGET
boolean canget(character character1, item item1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
This function has no general help information.
CANGET
boolean canget(character character1, item item1, number number1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
CANGET
boolean canget(character character1, item item1, item item11, text text1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
item11 | item | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
CANGET
boolean canget(character character1, item item1, item item11, number number1, text text1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
item11 | item | this parameter has no help information. |
number1 | number | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
CEILING
number ceiling(number number)
Parameter | Variable Type | Parameter Help |
number | number | the number to find the ceiling of |
Rounds a function up to the next highest integral number
CHARACTERISTICID
text characteristicid(character character, number characteristic)
Parameter | Variable Type | Parameter Help |
character | character | the character whose characteristics you are interested in probing |
characteristic | number | the id number of the characteristic definition you want to probe the value of |
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.
CHARACTERISTICID
text characteristicid(item item, number characteristic)
Parameter | Variable Type | Parameter Help |
item | item | the item whose characteristics you are interested in probing |
characteristic | number | the id number of the characteristic definition you want to probe the value of |
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.
CHARACTERISTICID
text characteristicid(character character, text characteristic)
Parameter | Variable Type | Parameter Help |
character | character | the character whose characteristics you are interested in probing |
characteristic | text | the name of the characteristic definition you want to probe the value of |
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.
CHARACTERISTICID
text characteristicid(item item, text characteristic)
Parameter | Variable Type | Parameter Help |
item | item | the item whose characteristics you are interested in probing |
characteristic | text | the name of the characteristic definition you want to probe the value of |
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.
CHARACTERISTICVALUE
text characteristicvalue(character character, number characteristic)
Parameter | Variable Type | Parameter Help |
character | character | the character whose characteristics you are interested in probing |
characteristic | number | the id number of the characteristic definition you want to probe the value of |
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.
CHARACTERISTICVALUE
text characteristicvalue(item item, number characteristic)
Parameter | Variable Type | Parameter Help |
item | item | the item whose characteristics you are interested in probing |
characteristic | number | the id number of the characteristic definition you want to probe the value of |
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.
CHARACTERISTICVALUE
text characteristicvalue(character character, text characteristic)
Parameter | Variable Type | Parameter Help |
character | character | the character whose characteristics you are interested in probing |
characteristic | text | the name of the characteristic definition you want to probe the value of |
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.
CHARACTERISTICVALUE
text characteristicvalue(item item, text characteristic)
Parameter | Variable Type | Parameter Help |
item | item | the item whose characteristics you are interested in probing |
characteristic | text | the name of the characteristic definition you want to probe the value of |
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.
CHECK
number check(character character, trait trait, number difficulty)
Parameter | Variable Type | Parameter Help |
character | character | the character whose trait you want to check against |
trait | trait | the trait you want to check |
difficulty | number | the difficulty of the check. 0 = automatic, 10 = impossible, 5 = normal |
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
CLANINVITE
boolean claninvite(character character1, clan clan1, rank rank1, character character11)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
clan1 | clan | this parameter has no help information. |
rank1 | rank | this parameter has no help information. |
character11 | character | this parameter has no help information. |
This function has no general help information.
CLANINVITE
boolean claninvite(character character1, clan clan1, rank rank1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
clan1 | clan | this parameter has no help information. |
rank1 | rank | this parameter has no help information. |
This function has no general help information.
CLANINVITE
boolean claninvite(character character1, clan clan1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
clan1 | clan | this parameter has no help information. |
This function has no general help information.
CLEARDESC
boolean cleardesc(perceivable perceivable)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable who's description is being altered |
Clears all custom full Desc overrides set by progs from this perceivable
CLEARDESC
boolean cleardesc(perceivable perceivable, text tag)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable who's description is being altered |
tag | text | a short bit of text identifying this specific effect set by the original overridedesc call |
Clears a custom full Desc override with the specified tag set by progs from this perceivable
CLEARMORPHTIMER
boolean clearmorphtimer(item item)
Parameter | Variable Type | Parameter Help |
item | item | the item who's morph timer you want to clear |
This function stops an item from morphing. Its timer will not resume unless specifically made to do so via SetMorphTimer. This function returns true unless there was a problem, e.g. item was null.
CLEARSDESC
boolean clearsdesc(perceivable perceivable)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable who's description is being altered |
Clears all custom SDesc overrides set by progs from this perceivable
CLEARSDESC
boolean clearsdesc(perceivable perceivable, text tag)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable who's description is being altered |
tag | text | a short bit of text identifying this specific effect set by the original overridesdesc call |
Clears a custom SDesc override with the specified tag set by progs from this perceivable
CLONEOUTFIT
outfit cloneoutfit(outfit outfit1, character character1, text text1)
Parameter | Variable Type | Parameter Help |
outfit1 | outfit | this parameter has no help information. |
character1 | character | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
CONCAT
text concat(text collection collection, text joiner)
Parameter | Variable Type | Parameter Help |
collection | text collection | the collection of text values you want to concatenate |
joiner | text | a joiner text to be inserted between each of the values, for example a comma or a space |
This function takes a collection of text values and joins them together with a specified joiner (which can be blank)
CONNECTTOGRID
boolean connecttogrid(number grid, item item)
Parameter | Variable Type | Parameter Help |
grid | number | the id of the grid you want to connect the item to |
item | item | the grid-interfacing item you want to connect |
This function takes a grid-interfacing item like a grid feeder or grid outlet and connects it. Returns true if it succeeded.
CONTAINS
boolean contains(void collection collection, collectionitem item)
Parameter | Variable Type | Parameter Help |
collection | void collection | the collection you want to check |
item | collectionitem | the item you are looking for in the collection |
This function allows you to test whether a given item is in a collection. True if the collection contains the item.
CONVERT
character convert(magicresourcehaver from, character to)
Parameter | Variable Type | Parameter Help |
from | magicresourcehaver | the variable that you want to convert. can be null. |
to | character | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
toon convert(magicresourcehaver from, toon to)
Parameter | Variable Type | Parameter Help |
from | magicresourcehaver | the variable that you want to convert. can be null. |
to | toon | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
item convert(magicresourcehaver from, item to)
Parameter | Variable Type | Parameter Help |
from | magicresourcehaver | the variable that you want to convert. can be null. |
to | item | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
location convert(magicresourcehaver from, location to)
Parameter | Variable Type | Parameter Help |
from | magicresourcehaver | the variable that you want to convert. can be null. |
to | location | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
character convert(perceiver from, character to)
Parameter | Variable Type | Parameter Help |
from | perceiver | the variable that you want to convert. can be null. |
to | character | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
item convert(perceiver from, item to)
Parameter | Variable Type | Parameter Help |
from | perceiver | the variable that you want to convert. can be null. |
to | item | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
character convert(perceivable from, character to)
Parameter | Variable Type | Parameter Help |
from | perceivable | the variable that you want to convert. can be null. |
to | character | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
item convert(perceivable from, item to)
Parameter | Variable Type | Parameter Help |
from | perceivable | the variable that you want to convert. can be null. |
to | item | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
location convert(perceivable from, location to)
Parameter | Variable Type | Parameter Help |
from | perceivable | the variable that you want to convert. can be null. |
to | location | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
zone convert(perceivable from, zone to)
Parameter | Variable Type | Parameter Help |
from | perceivable | the variable that you want to convert. can be null. |
to | zone | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
shard convert(perceivable from, shard to)
Parameter | Variable Type | Parameter Help |
from | perceivable | the variable that you want to convert. can be null. |
to | shard | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
character convert(referencetype from, character to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | character | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
location convert(referencetype from, location to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | location | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
item convert(referencetype from, item to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | item | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
shard convert(referencetype from, shard to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | shard | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
zone convert(referencetype from, zone to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | zone | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
race convert(referencetype from, race to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | race | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
culture convert(referencetype from, culture to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | culture | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
chargen convert(referencetype from, chargen to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | chargen | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
trait convert(referencetype from, trait to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | trait | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
clan convert(referencetype from, clan to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | clan | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
rank convert(referencetype from, rank to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | rank | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
appointment convert(referencetype from, appointment to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | appointment | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
paygrade convert(referencetype from, paygrade to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | paygrade | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
currency convert(referencetype from, currency to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | currency | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
exit convert(referencetype from, exit to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | exit | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
language convert(referencetype from, language to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | language | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
accent convert(referencetype from, accent to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | accent | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
merit convert(referencetype from, merit to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | merit | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
calendar convert(referencetype from, calendar to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | calendar | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
clock convert(referencetype from, clock to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | clock | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
effect convert(referencetype from, effect to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | effect | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
knowledge convert(referencetype from, knowledge to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | knowledge | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
role convert(referencetype from, role to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | role | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
ethnicity convert(referencetype from, ethnicity to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | ethnicity | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
drug convert(referencetype from, drug to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | drug | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
weatherevent convert(referencetype from, weatherevent to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | weatherevent | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
shop convert(referencetype from, shop to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | shop | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
merchandise convert(referencetype from, merchandise to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | merchandise | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
outfit convert(referencetype from, outfit to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | outfit | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
outfititem convert(referencetype from, outfititem to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | outfititem | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
project convert(referencetype from, project to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | project | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
overlaypackage convert(referencetype from, overlaypackage to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | overlaypackage | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
terrain convert(referencetype from, terrain to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | terrain | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
solid convert(referencetype from, solid to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | solid | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
liquid convert(referencetype from, liquid to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | liquid | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
gas convert(referencetype from, gas to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | gas | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
magicspell convert(referencetype from, magicspell to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | magicspell | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
magicschool convert(referencetype from, magicschool to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | magicschool | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
magiccapability convert(referencetype from, magiccapability to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | magiccapability | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
bank convert(referencetype from, bank to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | bank | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
bankaccount convert(referencetype from, bankaccount to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | bankaccount | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
bankaccounttype convert(referencetype from, bankaccounttype to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | bankaccounttype | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
legalauthority convert(referencetype from, legalauthority to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | legalauthority | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
law convert(referencetype from, law to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | law | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
crime convert(referencetype from, crime to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | crime | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
perceivable convert(referencetype from, perceivable to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | perceivable | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
perceiver convert(referencetype from, perceiver to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | perceiver | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
toon convert(referencetype from, toon to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | toon | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
magicresourcehaver convert(referencetype from, magicresourcehaver to)
Parameter | Variable Type | Parameter Help |
from | referencetype | the variable that you want to convert. can be null. |
to | magicresourcehaver | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
text convert(anything from, text to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | text | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
number convert(anything from, number to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | number | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
boolean convert(anything from, boolean to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | boolean | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
character convert(anything from, character to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | character | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
location convert(anything from, location to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | location | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
item convert(anything from, item to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | item | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
shard convert(anything from, shard to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | shard | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
gender convert(anything from, gender to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | gender | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
zone convert(anything from, zone to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | zone | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
void collection convert(anything from, void collection to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | void collection | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
race convert(anything from, race to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | race | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
culture convert(anything from, culture to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | culture | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
chargen convert(anything from, chargen to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | chargen | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
trait convert(anything from, trait to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | trait | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
clan convert(anything from, clan to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | clan | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
rank convert(anything from, rank to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | rank | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
appointment convert(anything from, appointment to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | appointment | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
paygrade convert(anything from, paygrade to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | paygrade | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
currency convert(anything from, currency to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | currency | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
exit convert(anything from, exit to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | exit | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
void convert(anything from, void to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | void | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
datetime convert(anything from, datetime to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | datetime | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
timespan convert(anything from, timespan to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | timespan | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
language convert(anything from, language to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | language | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
accent convert(anything from, accent to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | accent | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
merit convert(anything from, merit to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | merit | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
muddatetime convert(anything from, muddatetime to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | muddatetime | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
calendar convert(anything from, calendar to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | calendar | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
clock convert(anything from, clock to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | clock | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
effect convert(anything from, effect to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | effect | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
knowledge convert(anything from, knowledge to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | knowledge | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
role convert(anything from, role to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | role | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
ethnicity convert(anything from, ethnicity to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | ethnicity | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
drug convert(anything from, drug to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | drug | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
weatherevent convert(anything from, weatherevent to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | weatherevent | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
shop convert(anything from, shop to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | shop | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
merchandise convert(anything from, merchandise to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | merchandise | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
outfit convert(anything from, outfit to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | outfit | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
outfititem convert(anything from, outfititem to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | outfititem | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
project convert(anything from, project to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | project | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
overlaypackage convert(anything from, overlaypackage to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | overlaypackage | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
terrain convert(anything from, terrain to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | terrain | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
solid convert(anything from, solid to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | solid | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
liquid convert(anything from, liquid to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | liquid | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
gas convert(anything from, gas to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | gas | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
void dictionary convert(anything from, void dictionary to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | void dictionary | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
void collectiondictionary convert(anything from, void collectiondictionary to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | void collectiondictionary | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
magicspell convert(anything from, magicspell to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | magicspell | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
magicschool convert(anything from, magicschool to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | magicschool | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
magiccapability convert(anything from, magiccapability to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | magiccapability | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
bank convert(anything from, bank to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | bank | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
bankaccount convert(anything from, bankaccount to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | bankaccount | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
bankaccounttype convert(anything from, bankaccounttype to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | bankaccounttype | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
legalauthority convert(anything from, legalauthority to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | legalauthority | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
law convert(anything from, law to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | law | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
CONVERT
crime convert(anything from, crime to)
Parameter | Variable Type | Parameter Help |
from | anything | the variable that you want to convert. can be null. |
to | crime | a dummy variable of the type that you want to convert to. |
This function allows you to convert a variable from one type to another type.
COUNTACCESSIBLECURRENCY
number countaccessiblecurrency(character character1, currency currency1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
currency1 | currency | this parameter has no help information. |
This function has no general help information.
COUNTACCESSIBLECURRENCY
number countaccessiblecurrency(item item1, currency currency1)
Parameter | Variable Type | Parameter Help |
item1 | item | this parameter has no help information. |
currency1 | currency | this parameter has no help information. |
This function has no general help information.
COUNTACCESSIBLECURRENCY
number countaccessiblecurrency(location location1, currency currency1)
Parameter | Variable Type | Parameter Help |
location1 | location | this parameter has no help information. |
currency1 | currency | this parameter has no help information. |
This function has no general help information.
COUNTCURRENCY
number countcurrency(character character1, currency currency1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
currency1 | currency | this parameter has no help information. |
This function has no general help information.
COUNTCURRENCY
number countcurrency(item item1, currency currency1)
Parameter | Variable Type | Parameter Help |
item1 | item | this parameter has no help information. |
currency1 | currency | this parameter has no help information. |
This function has no general help information.
COUNTCURRENCY
number countcurrency(location location1, currency currency1)
Parameter | Variable Type | Parameter Help |
location1 | location | this parameter has no help information. |
currency1 | currency | this parameter has no help information. |
This function has no general help information.
CREATECELL
location createcell(overlaypackage package, zone zone)
Parameter | Variable Type | Parameter Help |
package | overlaypackage | the package that you want to approve |
zone | zone | the zone to create the room in |
Creates a new blank room in the specified package and zone
CREATECELL
location createcell(overlaypackage package, zone zone, location template)
Parameter | Variable Type | Parameter Help |
package | overlaypackage | the package that you want to approve |
zone | zone | the zone to create the room in |
template | location | a room to copy as the basic template of the new room |
Creates a new room based on the template room in the specified package and zone
CREATEOVERLAY
overlaypackage createoverlay(character builder, text name)
Parameter | Variable Type | Parameter Help |
builder | character | the builder who is creating the package |
name | text | the name of the package you want to create. must be unique. |
Creates a new cell overlay package with the specified name and builder, as if you had done CELL PACKAGE NEW. Can return null if the name is already taken so be sure to check for that.
CREATEROOM
location createroom(overlaypackage package, zone zone)
Parameter | Variable Type | Parameter Help |
package | overlaypackage | the package that you want to approve |
zone | zone | the zone to create the room in |
Creates a new blank room in the specified package and zone. Alias for CreateCell.
CREATEROOM
location createroom(overlaypackage package, zone zone, location template)
Parameter | Variable Type | Parameter Help |
package | overlaypackage | the package that you want to approve |
zone | zone | the zone to create the room in |
template | location | a room to copy as the basic template of the new room |
Creates a new room based on the template room in the specified package and zone. Alias for CreateCell.
CUSTOMLINKCELLS
exit customlinkcells(location location1, location location11, overlaypackage overlaypackage1, number number1, text text1, text text11, text text12, text text13)
Parameter | Variable Type | Parameter Help |
location1 | location | this parameter has no help information. |
location11 | location | this parameter has no help information. |
overlaypackage1 | overlaypackage | this parameter has no help information. |
number1 | number | this parameter has no help information. |
text1 | text | this parameter has no help information. |
text11 | text | this parameter has no help information. |
text12 | text | this parameter has no help information. |
text13 | text | this parameter has no help information. |
This function has no general help information.
CUSTOMLINKCELLS
exit customlinkcells(location location1, location location11, overlaypackage overlaypackage1, text text1, text text11, text text12, text text13, text text14)
Parameter | Variable Type | Parameter Help |
location1 | location | this parameter has no help information. |
location11 | location | this parameter has no help information. |
overlaypackage1 | overlaypackage | this parameter has no help information. |
text1 | text | this parameter has no help information. |
text11 | text | this parameter has no help information. |
text12 | text | this parameter has no help information. |
text13 | text | this parameter has no help information. |
text14 | text | this parameter has no help information. |
This function has no general help information.
DELETEITEM
boolean deleteitem(item item)
Parameter | Variable Type | Parameter Help |
item | item | the item that you want to delete |
Permanently deletes the specified item. Warning: this is unrecoverable. Returns true if the delete is successful.
DESCRIBECELL
boolean describecell(location room, overlaypackage package, text description)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to describe |
package | overlaypackage | the package that the description change belongs to |
description | text | the description that you are setting for that room |
Sets the description of a room as if you had done CELL SET DESCRIPTION.
DESCRIBEROOM
boolean describeroom(location room, overlaypackage package, text description)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to describe |
package | overlaypackage | the package that the description change belongs to |
description | text | the description that you are setting for that room |
Sets the description of a room as if you had done CELL SET DESCRIPTION. Alias for DescribeCell.
DETATCH
boolean detatch(item item1, item item11)
Parameter | Variable Type | Parameter Help |
item1 | item | this parameter has no help information. |
item11 | item | this parameter has no help information. |
This function has no general help information.
DROP
boolean drop(character character1, item item1, text text1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
DRUGEFFECTINTENSITY
number drugeffectintensity(character character1, number number1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
DRUGINTENSITY
number drugintensity(character character1, drug drug1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
drug1 | drug | this parameter has no help information. |
This function has no general help information.
EXITSFOROVERLAY
exit collection exitsforoverlay(location room, overlaypackage package)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to get exits for |
package | overlaypackage | the package that you want exits for. if null, uses currently approved package. |
Returns a collection of the exits for a room, in the specified package.
EXTENDGRID
boolean extendgrid(number grid, location location)
Parameter | Variable Type | Parameter Help |
grid | number | the id of the grid you want to extend |
location | location | the location you want to extend the grid to |
This function allows you to extend a grid (electrical, gas, liquid etc) to a new location. Returns true if the extension happened, false implies the grid was already present or there was another error.
FLOOR
number floor(number number)
Parameter | Variable Type | Parameter Help |
number | number | the number to find the floor of |
Rounds a function down to the next lowest integral number
FLUIDFROMTEXT
number fluidfromtext(text text1)
Parameter | Variable Type | Parameter Help |
text1 | text | this parameter has no help information. |
This function has no general help information.
FORCEOPEN
boolean forceopen(item item1, boolean boolean1, boolean boolean11)
Parameter | Variable Type | Parameter Help |
item1 | item | this parameter has no help information. |
boolean1 | boolean | this parameter has no help information. |
boolean11 | boolean | this parameter has no help information. |
This function has no general help information.
FORCEPUT
boolean forceput(item item1, item item11)
Parameter | Variable Type | Parameter Help |
item1 | item | this parameter has no help information. |
item11 | item | this parameter has no help information. |
This function has no general help information.
GAMESECONDSPERREALSECONDS
number gamesecondsperrealseconds(text text1)
Parameter | Variable Type | Parameter Help |
text1 | text | this parameter has no help information. |
This function has no general help information.
GET
boolean get(character character1, item item1, text text1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
GET
boolean get(character character1, item item1, number number1, text text1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
number1 | number | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
GET
boolean get(character character1, item item1, item item11, text text1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
item11 | item | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
GET
boolean get(character character1, item item1, item item11, number number1, text text1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
item11 | item | this parameter has no help information. |
number1 | number | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
GETCHARACTERISTIC
text getcharacteristic(unknown type thing, text target, perceiver perceiver)
Parameter | Variable Type | Parameter Help |
thing | unknown type | the thing whose characteristics you want to interrogate |
target | text | the name of the characteristic you want, including fancy or basic forms |
perceiver | perceiver | the perceiver through whose perspective these characteristics should be interpreted |
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.
GETINDEX
collectionitem getindex(void collection collection, number index)
Parameter | Variable Type | Parameter Help |
collection | void collection | a collection of anything |
index | number | the zero-based index of the element you want to retrieve from the collection |
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.
GETLIGHT
number getlight(perceiver perceiver)
Parameter | Variable Type | Parameter Help |
perceiver | perceiver | the perceiver for whom you would like to know the current light levels |
This function returns the current light level that a specified perceiver is exposed to. For characters, this would be the light levels in their room. For items, it is the maximum light levels in any room they are part of.
GETORCOPYEXIT
exit getorcopyexit(exit exit1, overlaypackage overlaypackage1)
Parameter | Variable Type | Parameter Help |
exit1 | exit | this parameter has no help information. |
overlaypackage1 | overlaypackage | this parameter has no help information. |
This function has no general help information.
GETREALCHARACTERISTIC
text getrealcharacteristic(unknown type thing, text target)
Parameter | Variable Type | Parameter Help |
thing | unknown type | the thing whose characteristics you want to interrogate |
target | text | the name of the characteristic you want, including fancy or basic forms |
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.
GETREGISTER
collectionitem getregister(collectionitem thing, text variable)
Parameter | Variable Type | Parameter Help |
thing | collectionitem | the thing whose register variables you want to retrieve |
variable | text | the register variable that you want to get. must be a string literal. |
This function retrieves the 'register variable' specified for a thing that you specify. Which register variables are available are defined on a per-type basis. See the REGISTER command in game for more information. The return type is as it appears in the register command, not actually a CollectionItem.
GETRESOURCE
number getresource(toon character, text resource)
Parameter | Variable Type | Parameter Help |
character | toon | the character whose account you want to look up |
resource | text | the name of the resource you want to look up |
Returns the amount of the specified chargen resources (karma, RPP, BP, etc) that an account has
GETTRAIT
number gettrait(toon who, trait trait)
Parameter | Variable Type | Parameter Help |
who | toon | the person whose traits you would like to interrogate |
trait | trait | the trait you want to know the value of |
This function returns the current trait value of the selected trait on the specified person
GETTRAITCAP
number gettraitcap(character who, trait trait)
Parameter | Variable Type | Parameter Help |
who | character | the person whose traits you would like to interrogate |
trait | trait | the trait you want to know the cap value of |
This function returns the trait cap of the selected trait on the specified person
GIVECURRENCY
boolean givecurrency(currency currency1, unknown type unknown type1, magicresourcehaver magicresourcehaver1, boolean boolean1)
Parameter | Variable Type | Parameter Help |
currency1 | currency | this parameter has no help information. |
unknown type1 | unknown type | this parameter has no help information. |
magicresourcehaver1 | magicresourcehaver | this parameter has no help information. |
boolean1 | boolean | this parameter has no help information. |
This function has no general help information.
GIVERESOURCE
number giveresource(toon character, text resource, number amount)
Parameter | Variable Type | Parameter Help |
character | toon | the character whose account should get the resources |
resource | text | the resource to give that account |
amount | number | the amount of resource to give |
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.
GIVETRAIT
number givetrait(character who, trait trait)
Parameter | Variable Type | Parameter Help |
who | character | the character to give the trait to |
trait | trait | the trait to give the character |
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
GIVETRAIT
number givetrait(character who, trait trait, number value)
Parameter | Variable Type | Parameter Help |
who | character | the character to give the trait to |
trait | trait | the trait to give the character |
value | number | 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
GPTREQUEST
boolean gptrequest(text thread, text message, character user, number maximumhistory, text function)
Parameter | Variable Type | Parameter Help |
thread | text | the gptthread to call |
message | text | the message to send to gpt |
user | character | the user whose history is being invoked |
maximumhistory | number | the maximum history entries |
function | text | a prog to call with the results of this request |
This function will schedule a call to GPT including a thread history, and call the specified prog with the outcome. Returns true if successfully queued.
GPTREQUEST
boolean gptrequest(number thread, text message, character user, number maximumhistory, text function)
Parameter | Variable Type | Parameter Help |
thread | number | the gptthread to call |
message | text | the message to send to gpt |
user | character | the user whose history is being invoked |
maximumhistory | number | the maximum history entries |
function | text | a prog to call with the results of this request |
This function will schedule a call to GPT including a thread history, and call the specified prog with the outcome. Returns true if successfully queued.
HOWSEEN
text howseen(perceivable thing, perceiver perceiver, boolean proper, boolean coloured)
Parameter | Variable Type | Parameter Help |
thing | perceivable | the thing for which you want a description |
perceiver | perceiver | the perceiver through whose perception you want to filter the description |
proper | boolean | whether or not to change the output to proper case |
coloured | boolean | whether or not to include colour in the description |
This function gets the short description of something as if it was seen in the engine by the specified perceiver.
HOWSEENFULL
text howseenfull(perceivable thing, perceiver perceiver, boolean proper, boolean coloured)
Parameter | Variable Type | Parameter Help |
thing | perceivable | the thing for which you want a description |
perceiver | perceiver | the perceiver through whose perception you want to filter the description |
proper | boolean | whether or not to change the output to proper case |
coloured | boolean | whether or not to include colour in the description |
This function gets the full (i.e. look) description of something as if it was seen in the engine by the specified perceiver.
HOWSEENLONG
text howseenlong(perceivable thing, perceiver perceiver, boolean proper, boolean coloured)
Parameter | Variable Type | Parameter Help |
thing | perceivable | the thing for which you want a description |
perceiver | perceiver | the perceiver through whose perception you want to filter the description |
proper | boolean | whether or not to change the output to proper case |
coloured | boolean | whether or not to include colour in the description |
This function gets the long (i.e. room) description of something as if it was seen in the engine by the specified perceiver.
HOWSEENSDESC
text howseensdesc(perceivable thing, perceiver perceiver, boolean proper, boolean coloured)
Parameter | Variable Type | Parameter Help |
thing | perceivable | the thing for which you want a description |
perceiver | perceiver | the perceiver through whose perception you want to filter the description |
proper | boolean | whether or not to change the output to proper case |
coloured | boolean | whether or not to include colour in the description |
This function gets the short description of something as if it was seen in the engine by the specified perceiver.
IFNULL
collectionitem ifnull(collectionitem item, collectionitem fallback)
Parameter | Variable Type | Parameter Help |
item | collectionitem | the item that you want to test to see if it is null |
fallback | collectionitem | the item you want to return if the first item is null |
This function accepts an item of a broad variety of types, and tests to see if it is currently null. If it is not null, it returns the item you supplied in the first parameter. If it is null, it returns the item specified in the second parameter.
IMPROVETRAIT
number improvetrait(character who, trait trait)
Parameter | Variable Type | Parameter Help |
who | character | the character to improve the trait of |
trait | trait | the trait to improve |
Gives a trait improvement tick to a trait. This is as if the player had rolled an improvement naturally. Returns the new value.
IN
boolean in(text target, text item1, text item2)
Parameter | Variable Type | Parameter Help |
target | text | the item you want to check is equal to any of the other supplied items |
item1 | text | an item to compare |
item2 | text | an item to compare |
This function determines whether the first supplied argument is 'in' the list of other arguments. It will return true if any of the other supplied text items match the first.
IN
boolean in(text target, text item1, text item2, text item3)
Parameter | Variable Type | Parameter Help |
target | text | the item you want to check is equal to any of the other supplied items |
item1 | text | an item to compare |
item2 | text | an item to compare |
item3 | text | an item to compare |
This function determines whether the first supplied argument is 'in' the list of other arguments. It will return true if any of the other supplied text items match the first.
IN
boolean in(text target, text item1, text item2, text item3, text item4)
Parameter | Variable Type | Parameter Help |
target | text | the item you want to check is equal to any of the other supplied items |
item1 | text | an item to compare |
item2 | text | an item to compare |
item3 | text | an item to compare |
item4 | text | an item to compare |
This function determines whether the first supplied argument is 'in' the list of other arguments. It will return true if any of the other supplied text items match the first.
IN
boolean in(text target, text item1, text item2, text item3, text item4, text item5)
Parameter | Variable Type | Parameter Help |
target | text | the item you want to check is equal to any of the other supplied items |
item1 | text | an item to compare |
item2 | text | an item to compare |
item3 | text | an item to compare |
item4 | text | an item to compare |
item5 | text | an item to compare |
This function determines whether the first supplied argument is 'in' the list of other arguments. It will return true if any of the other supplied text items match the first.
IN
boolean in(text target, text item1, text item2, text item3, text item4, text item5, text item6)
Parameter | Variable Type | Parameter Help |
target | text | the item you want to check is equal to any of the other supplied items |
item1 | text | an item to compare |
item2 | text | an item to compare |
item3 | text | an item to compare |
item4 | text | an item to compare |
item5 | text | an item to compare |
item6 | text | an item to compare |
This function determines whether the first supplied argument is 'in' the list of other arguments. It will return true if any of the other supplied text items match the first.
IN
boolean in(text target, text item1, text item2, text item3, text item4, text item5, text item6, text item7)
Parameter | Variable Type | Parameter Help |
target | text | the item you want to check is equal to any of the other supplied items |
item1 | text | an item to compare |
item2 | text | an item to compare |
item3 | text | an item to compare |
item4 | text | an item to compare |
item5 | text | an item to compare |
item6 | text | an item to compare |
item7 | text | an item to compare |
This function determines whether the first supplied argument is 'in' the list of other arguments. It will return true if any of the other supplied text items match the first.
IN
boolean in(text target, text item1, text item2, text item3, text item4, text item5, text item6, text item7, text item8)
Parameter | Variable Type | Parameter Help |
target | text | the item you want to check is equal to any of the other supplied items |
item1 | text | an item to compare |
item2 | text | an item to compare |
item3 | text | an item to compare |
item4 | text | an item to compare |
item5 | text | an item to compare |
item6 | text | an item to compare |
item7 | text | an item to compare |
item8 | text | an item to compare |
This function determines whether the first supplied argument is 'in' the list of other arguments. It will return true if any of the other supplied text items match the first.
IN
boolean in(text target, text item1, text item2, text item3, text item4, text item5, text item6, text item7, text item8, text item9)
Parameter | Variable Type | Parameter Help |
target | text | the item you want to check is equal to any of the other supplied items |
item1 | text | an item to compare |
item2 | text | an item to compare |
item3 | text | an item to compare |
item4 | text | an item to compare |
item5 | text | an item to compare |
item6 | text | an item to compare |
item7 | text | an item to compare |
item8 | text | an item to compare |
item9 | text | an item to compare |
This function determines whether the first supplied argument is 'in' the list of other arguments. It will return true if any of the other supplied text items match the first.
IN
boolean in(text target, text item1, text item2, text item3, text item4, text item5, text item6, text item7, text item8, text item9, text item10)
Parameter | Variable Type | Parameter Help |
target | text | the item you want to check is equal to any of the other supplied items |
item1 | text | an item to compare |
item2 | text | an item to compare |
item3 | text | an item to compare |
item4 | text | an item to compare |
item5 | text | an item to compare |
item6 | text | an item to compare |
item7 | text | an item to compare |
item8 | text | an item to compare |
item9 | text | an item to compare |
item10 | text | an item to compare |
This function determines whether the first supplied argument is 'in' the list of other arguments. It will return true if any of the other supplied text items match the first.
IN
boolean in(text target, text item1, text item2, text item3, text item4, text item5, text item6, text item7, text item8, text item9, text item10, text item11)
Parameter | Variable Type | Parameter Help |
target | text | the item you want to check is equal to any of the other supplied items |
item1 | text | an item to compare |
item2 | text | an item to compare |
item3 | text | an item to compare |
item4 | text | an item to compare |
item5 | text | an item to compare |
item6 | text | an item to compare |
item7 | text | an item to compare |
item8 | text | an item to compare |
item9 | text | an item to compare |
item10 | text | an item to compare |
item11 | text | an item to compare |
This function determines whether the first supplied argument is 'in' the list of other arguments. It will return true if any of the other supplied text items match the first.
INCUSTODYOFENFORCER
boolean incustodyofenforcer(character character)
Parameter | Variable Type | Parameter Help |
character | character | the character who you want to check for being in custody |
This function checks if the character is currently in the physical custody of any enforcers
INDEXOF
number indexof(void collection collection, collectionitem item)
Parameter | Variable Type | Parameter Help |
collection | void collection | a collection of anything |
item | collectionitem | the item whose position in the collection you want to know |
This function returns the zero-based index of a specified item in the collection, if present. If not present it returns -1.
INPRISON
boolean inprison(character character, legalauthority authority)
Parameter | Variable Type | Parameter Help |
character | character | the character who you want to check for being in prison |
authority | legalauthority | the legal authority to check in, or null for all |
This function checks if the character is currently serving a prison sentence
INSTALLDOOR
boolean installdoor(exit exit1, item item1, location location1, location location11)
Parameter | Variable Type | Parameter Help |
exit1 | exit | this parameter has no help information. |
item1 | item | this parameter has no help information. |
location1 | location | this parameter has no help information. |
location11 | location | this parameter has no help information. |
This function has no general help information.
ISADMIN
boolean isadmin(toon toon)
Parameter | Variable Type | Parameter Help |
toon | toon | the character or toon whose status as an admin you want to test |
This function tells you if the person you specify, which can be a character, chargen or NPC template, is an admin
ISCLANBROTHER
boolean isclanbrother(character character1, character character11, clan clan1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
character11 | character | this parameter has no help information. |
clan1 | clan | this parameter has no help information. |
This function has no general help information.
ISCLANBROTHER
boolean isclanbrother(character character1, character character11)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
character11 | character | this parameter has no help information. |
This function has no general help information.
ISCLANBROTHER
boolean isclanbrother(character character1, character character11, clan collection clan collection1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
character11 | character | this parameter has no help information. |
clan collection1 | clan collection | this parameter has no help information. |
This function has no general help information.
ISCLANMEMBER
boolean isclanmember(character character1, clan clan1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
clan1 | clan | this parameter has no help information. |
This function has no general help information.
ISCLANMEMBER
boolean isclanmember(character character1, clan clan1, rank rank1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
clan1 | clan | this parameter has no help information. |
rank1 | rank | this parameter has no help information. |
This function has no general help information.
ISCLANMEMBER
boolean isclanmember(character character1, clan clan1, appointment appointment1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
clan1 | clan | this parameter has no help information. |
appointment1 | appointment | this parameter has no help information. |
This function has no general help information.
ISCLANMEMBER
boolean isclanmember(character character1, clan clan1, rank rank1, paygrade paygrade1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
clan1 | clan | this parameter has no help information. |
rank1 | rank | this parameter has no help information. |
paygrade1 | paygrade | this parameter has no help information. |
This function has no general help information.
ISENFORCER
boolean isenforcer(character character, legalauthority authority)
Parameter | Variable Type | Parameter Help |
character | character | the character you want to check |
authority | legalauthority | the legal authority to check in, or if null, checks all of the authorities |
Returns true if the character is an enforcer in the specified legal authority or authorities
ISFELON
boolean isfelon(character character, legalauthority authority)
Parameter | Variable Type | Parameter Help |
character | character | the character to check |
authority | legalauthority | the legal authority in which to check, or all authorities if null |
This function checks to see if the character has ever had a serious crime (one that incurred jail time or capital punishment) recorded against them
ISFELON
boolean isfelon(character character)
Parameter | Variable Type | Parameter Help |
character | character | the character to check |
This function checks to see if the character has ever had a serious crime (one that incurred jail time or capital punishment) recorded against them
ISNULL
boolean isnull(collectionitem item)
Parameter | Variable Type | Parameter Help |
item | collectionitem | the item that you want to test to see if it is null |
This function accepts an item of a broad variety of types, and tests to see if it is currently null.
ISSWIMLAYER
boolean isswimlayer(location location, text layer)
Parameter | Variable Type | Parameter Help |
location | location | the location whose layers you want to check for being a swimming layer |
layer | text | the room layer that you want to test for being a swimming layer |
This function allows you to test whether a particular room layer in a location is currently a swimming layer. Possible values for layers are VeryDeepUnderwater, DeepUnderwater, Underwater, GroundLevel, OnRooftops, InTrees, HighInTrees, InAir, HighInAir. See function ROOMLAYERS for how to obtain the list of room layers for a location.
ISTAGGED
boolean istagged(tagged thing, text tag)
Parameter | Variable Type | Parameter Help |
thing | tagged | the thing whose tags you want to interrogate |
tag | text | the name of the tag you want to test for |
Returns whether or not the thing has or counts as the specified tag. For example, if you specify the tag 'Cutting Implement' and thing is tagged with the 'Knife' tag, and Knife is a Cutting Implement, then thing is a cutting implement.
ISTAGGED
boolean istagged(tagged thing, number tag)
Parameter | Variable Type | Parameter Help |
thing | tagged | the thing whose tags you want to interrogate |
tag | number | the id of the tag you want to test for |
Returns whether or not the thing has or counts as the specified tag. For example, if you specify the tag 'Cutting Implement' and thing is tagged with the 'Knife' tag, and Knife is a Cutting Implement, then thing is a cutting implement.
ISTERRITORY
boolean isterritory(character character1, location location1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
location1 | location | this parameter has no help information. |
This function has no general help information.
ISTERRITORY
boolean isterritory(character character1, location location1, text text1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
location1 | location | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
ISTERRITORY
boolean isterritory(character character1, location location1, text text1, text text11)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
location1 | location | this parameter has no help information. |
text1 | text | this parameter has no help information. |
text11 | text | this parameter has no help information. |
This function has no general help information.
ISTERRITORY
boolean isterritory(character character1, location location1, text text1, text text11, text text12)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
location1 | location | this parameter has no help information. |
text1 | text | this parameter has no help information. |
text11 | text | this parameter has no help information. |
text12 | text | this parameter has no help information. |
This function has no general help information.
ISUNDERWATER
boolean isunderwater(location location, text layer)
Parameter | Variable Type | Parameter Help |
location | location | the location whose layers you want to check for being underwater |
layer | text | the room layer that you want to test for being underwater |
This function allows you to test whether a particular room layer in a location is currently underwater. Possible values for layers are VeryDeepUnderwater, DeepUnderwater, Underwater, GroundLevel, OnRooftops, InTrees, HighInTrees, InAir, HighInAir. See function ROOMLAYERS for how to obtain the list of room layers for a location.
ISWANTED
boolean iswanted(character character, legalauthority legalauthority)
Parameter | Variable Type | Parameter Help |
character | character | the character whose wanted status you want to know |
legalauthority | legalauthority | the legal authority you're checking against, or null if checking against all |
This function determines if the supplied character is wanted for arrest in the specified legal authority
KILL
item kill(character victim, boolean makecorpse)
Parameter | Variable Type | Parameter Help |
victim | character | the character who you want to kill |
makecorpse | boolean | if true, leaves a corpse behind. otherwise disposes of corpse. |
Kills the specified character, and optionally leaves a corpse. Returns the corpse as an item.
KNOWNCRIMES
crime collection knowncrimes(character character, legalauthority authority)
Parameter | Variable Type | Parameter Help |
character | character | the character to fetch crimes for |
authority | legalauthority | the authority to check crimes in, or if null, all authorities |
Returns a list of all the unresolved crimes known to authorities in the specified authority (or authorities)
LAYERCHARACTERS
character collection layercharacters(location location, text layer)
Parameter | Variable Type | Parameter Help |
location | location | the location whose characters you want to return |
layer | text | the layer where you want characters from |
This function returns the characters that are present at a specified layer in a room. See the ROOMLAYERS function for information on how to determine what layers are present.
LAYEREXITS
exit collection layerexits(location location, text layer)
Parameter | Variable Type | Parameter Help |
location | location | the location whose exits you are interested in |
layer | text | the layer whose exits you want |
This function returns the exits that exist at a particular layer in a location you specify. See the ROOMLAYERS function for information on how to determine what layers are present.
LAYEREXITS
exit collection layerexits(location location, character character)
Parameter | Variable Type | Parameter Help |
location | location | the location whose exits you are interested in |
character | character | the character whose layer exits you want |
This function returns the exits that exist at a particular layer in a location you specify. See the ROOMLAYERS function for information on how to determine what layers are present.
LAYEREXITS
exit collection layerexits(location location, item item)
Parameter | Variable Type | Parameter Help |
location | location | the location whose exits you are interested in |
item | item | the item whose layer exits you want |
This function returns the exits that exist at a particular layer in a location you specify. See the ROOMLAYERS function for information on how to determine what layers are present.
LAYERITEMS
item collection layeritems(location location, text layer)
Parameter | Variable Type | Parameter Help |
location | location | the location whose items you want to return |
layer | text | the layer where you want items from |
This function returns the items that are present at a specified layer in a room. See the ROOMLAYERS function for information on how to determine what layers are present.
LENGTHFROMTEXT
number lengthfromtext(text text1)
Parameter | Variable Type | Parameter Help |
text1 | text | this parameter has no help information. |
This function has no general help information.
LINKCELLS
exit linkcells(location location1, location location11, overlaypackage overlaypackage1, number number1)
Parameter | Variable Type | Parameter Help |
location1 | location | this parameter has no help information. |
location11 | location | this parameter has no help information. |
overlaypackage1 | overlaypackage | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
LINKCELLS
exit linkcells(location location1, location location11, overlaypackage overlaypackage1, text text1)
Parameter | Variable Type | Parameter Help |
location1 | location | this parameter has no help information. |
location11 | location | this parameter has no help information. |
overlaypackage1 | overlaypackage | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
LOADCOINS
item loadcoins(currency currency1, text text1)
Parameter | Variable Type | Parameter Help |
currency1 | currency | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
LOADCOMMODITY
item loadcommodity(number material, number weight)
Parameter | Variable Type | Parameter Help |
material | number | the id of the material that you want to load |
weight | number | the weight of the material to load in base units for this mud. see mud owner for configuration info. |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(text material, number weight)
Parameter | Variable Type | Parameter Help |
material | text | the name of the material that you want to load |
weight | number | the weight of the material to load in base units for this mud. see mud owner for configuration info. |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(number material, text weight)
Parameter | Variable Type | Parameter Help |
material | number | the id of the material that you want to load |
weight | text | the weight of the material to load, e.g. 15.3kg, 12lb etc |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(text material, text weight)
Parameter | Variable Type | Parameter Help |
material | text | the name of the material that you want to load |
weight | text | the weight of the material to load, e.g. 15.3kg, 12lb etc |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(solid material, number weight)
Parameter | Variable Type | Parameter Help |
material | solid | the material that you want to load |
weight | number | the weight of the material to load in base units for this mud. see mud owner for configuration info. |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(solid material, text weight)
Parameter | Variable Type | Parameter Help |
material | solid | the material that you want to load |
weight | text | the weight of the material to load, e.g. 15.3kg, 12lb etc |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(number material, number weight, number tag)
Parameter | Variable Type | Parameter Help |
material | number | the id of the material that you want to load |
weight | number | the weight of the material to load in base units for this mud. see mud owner for configuration info. |
tag | number | the id of the tag that you want to load |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(text material, number weight, number tag)
Parameter | Variable Type | Parameter Help |
material | text | the name of the material that you want to load |
weight | number | the weight of the material to load in base units for this mud. see mud owner for configuration info. |
tag | number | the id of the tag that you want to load |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(number material, text weight, number tag)
Parameter | Variable Type | Parameter Help |
material | number | the id of the material that you want to load |
weight | text | the weight of the material to load, e.g. 15.3kg, 12lb etc |
tag | number | the id of the tag that you want to load |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(text material, text weight, number tag)
Parameter | Variable Type | Parameter Help |
material | text | the name of the material that you want to load |
weight | text | the weight of the material to load, e.g. 15.3kg, 12lb etc |
tag | number | the id of the tag that you want to load |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(solid material, number weight, number tag)
Parameter | Variable Type | Parameter Help |
material | solid | the material that you want to load |
weight | number | the weight of the material to load in base units for this mud. see mud owner for configuration info. |
tag | number | the id of the tag that you want to load |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(solid material, text weight, number tag)
Parameter | Variable Type | Parameter Help |
material | solid | the material that you want to load |
weight | text | the weight of the material to load, e.g. 15.3kg, 12lb etc |
tag | number | the id of the tag that you want to load |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(number material, number weight, text tag)
Parameter | Variable Type | Parameter Help |
material | number | the id of the material that you want to load |
weight | number | the weight of the material to load in base units for this mud. see mud owner for configuration info. |
tag | text | the name of the tag that you want to load |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(text material, number weight, text tag)
Parameter | Variable Type | Parameter Help |
material | text | the name of the material that you want to load |
weight | number | the weight of the material to load in base units for this mud. see mud owner for configuration info. |
tag | text | the name of the tag that you want to load |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(number material, text weight, text tag)
Parameter | Variable Type | Parameter Help |
material | number | the id of the material that you want to load |
weight | text | the weight of the material to load, e.g. 15.3kg, 12lb etc |
tag | text | the name of the tag that you want to load |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(text material, text weight, text tag)
Parameter | Variable Type | Parameter Help |
material | text | the name of the material that you want to load |
weight | text | the weight of the material to load, e.g. 15.3kg, 12lb etc |
tag | text | the name of the tag that you want to load |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(solid material, number weight, text tag)
Parameter | Variable Type | Parameter Help |
material | solid | the material that you want to load |
weight | number | the weight of the material to load in base units for this mud. see mud owner for configuration info. |
tag | text | the name of the tag that you want to load |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCOMMODITY
item loadcommodity(solid material, text weight, text tag)
Parameter | Variable Type | Parameter Help |
material | solid | the material that you want to load |
weight | text | the weight of the material to load, e.g. 15.3kg, 12lb etc |
tag | text | the name of the tag that you want to load |
This function loads a new commodity item into the game. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADCURRENCY
item loadcurrency(currency currency1, number number1)
Parameter | Variable Type | Parameter Help |
currency1 | currency | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
LOADCURRENCY
item loadcurrency(currency currency1, text text1)
Parameter | Variable Type | Parameter Help |
currency1 | currency | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
LOADITEM
item loaditem(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id of the item prototype that you want to load |
This function loads a new item into the game based on the ID that you supply. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADITEM
item loaditem(number id, number quantity)
Parameter | Variable Type | Parameter Help |
id | number | the id of the item prototype that you want to load |
quantity | number | the quantity of the item you want to load. if this item is not stackable, this input is ignored. |
This function loads a new item into the game based on the ID that you supply. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADITEM
item loaditem(number id, text variables)
Parameter | Variable Type | Parameter Help |
id | number | the id of the item prototype that you want to load |
variables | text | the default values for any variables on this item. this syntax is as per using the item load command in game, which means the general syntax is varname=value or varname="longer value", with multiple variables separated by spaces |
This function loads a new item into the game based on the ID that you supply. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADITEM
item loaditem(number id, number quantity, text variables)
Parameter | Variable Type | Parameter Help |
id | number | the id of the item prototype that you want to load |
quantity | number | the quantity of the item you want to load. if this item is not stackable, this input is ignored |
variables | text | the default values for any variables on this item. this syntax is as per using the item load command in game, which means the general syntax is varname=value or varname="longer value", with multiple variables separated by spaces |
This function loads a new item into the game based on the ID that you supply. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory.
LOADNPC
character loadnpc(number id, location location)
Parameter | Variable Type | Parameter Help |
id | number | the id of the npc template to load |
location | location | the location into which they will be loaded |
This function loads an NPC from a specified template into a location.
LOADNPC
character loadnpc(number id, location location, text layer)
Parameter | Variable Type | Parameter Help |
id | number | the id of the npc template to load |
location | location | the location into which they will be loaded |
layer | text | the layer into which to load the npc |
This function loads an NPC from a specified template into a location.
MASSFROMTEXT
number massfromtext(text text1)
Parameter | Variable Type | Parameter Help |
text1 | text | this parameter has no help information. |
This function has no general help information.
MAX
number max(number number1, number number11)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
number11 | number | this parameter has no help information. |
This function has no general help information.
MIN
number min(number number1, number number11)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
number11 | number | this parameter has no help information. |
This function has no general help information.
NAMECELL
boolean namecell(location room, overlaypackage package, text name)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to name |
package | overlaypackage | the package that the name change belongs to |
name | text | the name that you are setting for that room |
Sets the name of a room as if you had done CELL SET NAME.
NAMEROOM
boolean nameroom(location room, overlaypackage package, text name)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to name |
package | overlaypackage | the package that the name change belongs to |
name | text | the name that you are setting for that room |
Sets the name of a room as if you had done CELL SET NAME. Alias for NameCell.
NEWOUTFIT
outfit newoutfit(character character1, text text1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
NOT
boolean not(boolean item)
Parameter | Variable Type | Parameter Help |
item | boolean | the boolean you want to change |
This function takes a boolean and transforms it into the opposite value - e.g. True becomes False, False becomes True.
NOW
datetime now()
Parameter | Variable Type | Parameter Help |
This function has no general help information.
NOW
muddatetime now(calendar calendar1)
Parameter | Variable Type | Parameter Help |
calendar1 | calendar | this parameter has no help information. |
This function has no general help information.
NOW
muddatetime now(calendar calendar1, clock clock1)
Parameter | Variable Type | Parameter Help |
calendar1 | calendar | this parameter has no help information. |
clock1 | clock | this parameter has no help information. |
This function has no general help information.
NOW
muddatetime now(calendar calendar1, clock clock1, text text1)
Parameter | Variable Type | Parameter Help |
calendar1 | calendar | this parameter has no help information. |
clock1 | clock | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
NULL
anything null(text type)
Parameter | Variable Type | Parameter Help |
type | text | a text literal specifying the type of null variable. |
Returns a null variable of the type specified.
ONBAIL
boolean onbail(character character, legalauthority authority)
Parameter | Variable Type | Parameter Help |
character | character | the character who you want to check for bail |
authority | legalauthority | the legal authority to check in, or null for all |
This function checks if the character is currently on bail for any crimes
ONGOODBEHAVIORBOND
boolean ongoodbehaviorbond(character character, legalauthority authority)
Parameter | Variable Type | Parameter Help |
character | character | the character who you want to check for being on good behavior |
authority | legalauthority | the legal authority to check in, or null for all |
This function checks if the character is currently on a good behavior bond for a previous crime. Alternate spelling version for US English proggers.
ONGOODBEHAVIOURBOND
boolean ongoodbehaviourbond(character character, legalauthority authority)
Parameter | Variable Type | Parameter Help |
character | character | the character who you want to check for being on good behaviour |
authority | legalauthority | the legal authority to check in, or null for all |
This function checks if the character is currently on a good behaviour bond for a previous crime
OUTRANKS
boolean outranks(character character1, character character11, clan clan1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
character11 | character | this parameter has no help information. |
clan1 | clan | this parameter has no help information. |
This function has no general help information.
OVERRIDEDESC
boolean overridedesc(perceivable perceivable, text tag, text description)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable who's description is being altered |
tag | text | a short bit of text identifying this specific effect and allowing you to remove it later |
description | text | the overriden description for this perceivable. can include description markups |
This function adds an override to the target's full description, which applies to all perceivers. Lasts until the ClearDesc function is used on this perceivable.
OVERRIDEDESC
boolean overridedesc(perceivable perceivable, text tag, text description, timespan time)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable who's description is being altered |
tag | text | a short bit of text identifying this specific effect and allowing you to remove it later |
description | text | the overriden description for this perceivable. can include description markups |
time | timespan | the time that this effect will apply for. if null, applies forever |
This function adds an override to the target's full description, which applies to all perceivers. Lasts until the specified duration, or until ClearDesc called if null.
OVERRIDEDESC
boolean overridedesc(perceivable perceivable, text tag, text description, timespan time, perceiver perceiver)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable who's description is being altered |
tag | text | a short bit of text identifying this specific effect and allowing you to remove it later |
description | text | the overriden description for this perceivable. can include description markups |
time | timespan | the time that this effect will apply for. if null, applies forever |
perceiver | perceiver | if specified, the description is only overriden for this perceiver. if null, applies to everyone |
This function adds an override to the target's full description, which applies to the specified perceiver only (or all perceivers if null). Lasts until the specified duration, or until ClearDesc called if null.
OVERRIDEDESC
boolean overridedesc(perceivable perceivable, text tag, text description, timespan time, perceiver perceiver, text prog)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable who's description is being altered |
tag | text | a short bit of text identifying this specific effect and allowing you to remove it later |
description | text | the overriden description for this perceivable. can include description markups |
time | timespan | the time that this effect will apply for. if null, applies forever |
perceiver | perceiver | if specified, the description is only overriden for this perceiver. if null, applies to everyone |
prog | text | a prog taking a perceivable and perceiver input (or just a single perceivable) and returning boolean that controls whether this applies |
This function adds an override to the target's full description, which applies to the specified perceiver only (or all perceivers if null) and only when the filter prog applies. Lasts until the specified duration, or until ClearDesc called if null.
OVERRIDEDESC
boolean overridedesc(perceivable perceivable, text tag, text description, timespan time, perceiver perceiver, number prog)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable who's description is being altered |
tag | text | a short bit of text identifying this specific effect and allowing you to remove it later |
description | text | the overriden description for this perceivable. can include description markups |
time | timespan | the time that this effect will apply for. if null, applies forever |
perceiver | perceiver | if specified, the description is only overriden for this perceiver. if null, applies to everyone |
prog | number | a prog taking a perceivable and perceiver input (or just a single perceivable) and returning boolean that controls whether this applies |
This function adds an override to the target's full description, which applies to the specified perceiver only (or all perceivers if null) and only when the filter prog applies. Lasts until the specified duration, or until ClearDesc called if null.
OVERRIDESDESC
boolean overridesdesc(perceivable perceivable, text tag, text description)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable who's description is being altered |
tag | text | a short bit of text identifying this specific effect and allowing you to remove it later |
description | text | the overriden description for this perceivable. can include description markups |
This function adds an override to the target's short description, which applies to all perceivers. Lasts until the ClearSDesc function is used on this perceivable.
OVERRIDESDESC
boolean overridesdesc(perceivable perceivable, text tag, text description, timespan time)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable who's description is being altered |
tag | text | a short bit of text identifying this specific effect and allowing you to remove it later |
description | text | the overriden description for this perceivable. can include description markups |
time | timespan | the time that this effect will apply for. if null, applies forever |
This function adds an override to the target's short description, which applies to all perceivers. Lasts until the specified duration, or until ClearSDesc called if null.
OVERRIDESDESC
boolean overridesdesc(perceivable perceivable, text tag, text description, timespan time, perceiver perceiver)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable who's description is being altered |
tag | text | a short bit of text identifying this specific effect and allowing you to remove it later |
description | text | the overriden description for this perceivable. can include description markups |
time | timespan | the time that this effect will apply for. if null, applies forever |
perceiver | perceiver | if specified, the description is only overriden for this perceiver. if null, applies to everyone |
This function adds an override to the target's short description, which applies to the specified perceiver only (or all perceivers if null). Lasts until the specified duration, or until ClearSDesc called if null.
OVERRIDESDESC
boolean overridesdesc(perceivable perceivable, text tag, text description, timespan time, perceiver perceiver, text prog)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable who's description is being altered |
tag | text | a short bit of text identifying this specific effect and allowing you to remove it later |
description | text | the overriden description for this perceivable. can include description markups |
time | timespan | the time that this effect will apply for. if null, applies forever |
perceiver | perceiver | if specified, the description is only overriden for this perceiver. if null, applies to everyone |
prog | text | a prog taking a perceivable and perceiver input (or just a single perceivable) and returning boolean that controls whether this applies |
This function adds an override to the target's short description, which applies to the specified perceiver only (or all perceivers if null) and only when the filter prog applies. Lasts until the specified duration, or until ClearSDesc called if null.
OVERRIDESDESC
boolean overridesdesc(perceivable perceivable, text tag, text description, timespan time, perceiver perceiver, number prog)
Parameter | Variable Type | Parameter Help |
perceivable | perceivable | the perceivable who's description is being altered |
tag | text | a short bit of text identifying this specific effect and allowing you to remove it later |
description | text | the overriden description for this perceivable. can include description markups |
time | timespan | the time that this effect will apply for. if null, applies forever |
perceiver | perceiver | if specified, the description is only overriden for this perceiver. if null, applies to everyone |
prog | number | a prog taking a perceivable and perceiver input (or just a single perceivable) and returning boolean that controls whether this applies |
This function adds an override to the target's short description, which applies to the specified perceiver only (or all perceivers if null) and only when the filter prog applies. Lasts until the specified duration, or until ClearSDesc called if null.
PUT
boolean put(character character1, item item1, item item11, text text1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
item11 | item | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
PUT
boolean put(item item1, item item11)
Parameter | Variable Type | Parameter Help |
item1 | item | this parameter has no help information. |
item11 | item | this parameter has no help information. |
This function has no general help information.
PUT
boolean put(item item, location location)
Parameter | Variable Type | Parameter Help |
item | item | the item you want to drop |
location | location | the location you want to put the item in |
This function puts an item in a room, using the GroundLevel (or closest layer to).
PUT
boolean put(item item, location location, text layer)
Parameter | Variable Type | Parameter Help |
item | item | the item you want to drop |
location | location | the location you want to put the item in |
layer | text | the layer of the location that you want to put the item in |
This function puts an item in a room in the specified layer. Possible values for layers are VeryDeepUnderwater, DeepUnderwater, Underwater, GroundLevel, OnRooftops, InTrees, HighInTrees, InAir, HighInAir. See function ROOMLAYERS for how to obtain the list of room layers for a location.
RANDOM
number random(number number1, number number11)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
number11 | number | this parameter has no help information. |
This function has no general help information.
REMOVE
boolean remove(character character1, item item1, text text1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
REMOVEDOOR
item removedoor(exit exit1)
Parameter | Variable Type | Parameter Help |
exit1 | exit | this parameter has no help information. |
This function has no general help information.
REMOVEHOOK
boolean removehook(perceivable perceivable1, number number1)
Parameter | Variable Type | Parameter Help |
perceivable1 | perceivable | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
REMOVEHOOK
boolean removehook(perceivable perceivable1, text text1)
Parameter | Variable Type | Parameter Help |
perceivable1 | perceivable | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
REMOVEOUTFIT
boolean removeoutfit(character character1, outfit outfit1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
outfit1 | outfit | this parameter has no help information. |
This function has no general help information.
REMOVEOUTFIT
boolean removeoutfit(character character1, outfit outfit1, item item1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
outfit1 | outfit | this parameter has no help information. |
item1 | item | this parameter has no help information. |
This function has no general help information.
REMOVEOUTFITFORCE
boolean removeoutfitforce(character character1, outfit outfit1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
outfit1 | outfit | this parameter has no help information. |
This function has no general help information.
REMOVEOUTFITFORCE
boolean removeoutfitforce(character character1, outfit outfit1, item item1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
outfit1 | outfit | this parameter has no help information. |
item1 | item | this parameter has no help information. |
This function has no general help information.
RENAMEOUTFIT
boolean renameoutfit(outfit outfit1, text text1)
Parameter | Variable Type | Parameter Help |
outfit1 | outfit | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
RESOLVEDCRIMES
crime collection resolvedcrimes(character character, legalauthority authority)
Parameter | Variable Type | Parameter Help |
character | character | the character to fetch crimes for |
authority | legalauthority | the authority to check crimes in, or if null, all authorities |
Returns a list of all the resolved crimes in the specified authority (or authorities)
REVISEOVERLAY
overlaypackage reviseoverlay(overlaypackage package, character builder)
Parameter | Variable Type | Parameter Help |
package | overlaypackage | the package that you want to revise |
builder | character | the builder who is doing the revision |
Creates a new revision for an overlay package.
ROOMLAYERS
text collection roomlayers(location location)
Parameter | Variable Type | Parameter Help |
location | location | the location whose layers you want to determine |
This function returns a collection of text values representing all the layers in the specified cell. Possible values for layers are VeryDeepUnderwater, DeepUnderwater, Underwater, GroundLevel, OnRooftops, InTrees, HighInTrees, InAir, HighInAir.
ROOMLAYERS
text collection roomlayers(location location, overlaypackage package)
Parameter | Variable Type | Parameter Help |
location | location | the location whose layers you want to determine |
package | overlaypackage | the package you want to use to evaluate what terrain type this location is |
This function returns a collection of text values representing all the layers in the specified cell. Possible values for layers are VeryDeepUnderwater, DeepUnderwater, Underwater, GroundLevel, OnRooftops, InTrees, HighInTrees, InAir, HighInAir.
ROUND
number round(number number)
Parameter | Variable Type | Parameter Help |
number | number | the number to round |
Rounds a function to zero decimal places
ROUND
number round(number number, number decimals)
Parameter | Variable Type | Parameter Help |
number | number | the number to round |
decimals | number | the number of decimal places |
Rounds a function to the specified amount of decimal places
SAMERACE
boolean samerace(race race1, race race11)
Parameter | Variable Type | Parameter Help |
race1 | race | this parameter has no help information. |
race11 | race | this parameter has no help information. |
This function has no general help information.
SEND
boolean send(perceiver perceiver1, text text1)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
SEND
boolean send(perceiver perceiver1, text text1, perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
This function has no general help information.
SEND
boolean send(perceiver perceiver1, text text1, perceivable perceivable1, perceivable perceivable11)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
This function has no general help information.
SEND
boolean send(perceiver perceiver1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
This function has no general help information.
SEND
boolean send(perceiver perceiver1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
This function has no general help information.
SEND
boolean send(perceiver perceiver1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
This function has no general help information.
SEND
boolean send(perceiver perceiver1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
This function has no general help information.
SEND
boolean send(perceiver perceiver1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
This function has no general help information.
SEND
boolean send(perceiver perceiver1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16, perceivable perceivable17)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
perceivable17 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDDISCORD
boolean senddiscord(number number1, text text1, text text11)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
text1 | text | this parameter has no help information. |
text11 | text | this parameter has no help information. |
This function has no general help information.
SENDFIXED
boolean sendfixed(perceiver perceiver1, text text1)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
SENDFIXED
boolean sendfixed(perceiver perceiver1, text text1, perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDFIXED
boolean sendfixed(perceiver perceiver1, text text1, perceivable perceivable1, perceivable perceivable11)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDFIXED
boolean sendfixed(perceiver perceiver1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDFIXED
boolean sendfixed(perceiver perceiver1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDFIXED
boolean sendfixed(perceiver perceiver1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDFIXED
boolean sendfixed(perceiver perceiver1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDFIXED
boolean sendfixed(perceiver perceiver1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDFIXED
boolean sendfixed(perceiver perceiver1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16, perceivable perceivable17)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
perceivable17 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDLANG
boolean sendlang(perceiver perceiver1, text text1, language language1, accent accent1)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
This function has no general help information.
SENDLANG
boolean sendlang(perceiver perceiver1, text text1, language language1, accent accent1, perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDLANG
boolean sendlang(perceiver perceiver1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDLANG
boolean sendlang(perceiver perceiver1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDLANG
boolean sendlang(perceiver perceiver1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDLANG
boolean sendlang(perceiver perceiver1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDLANG
boolean sendlang(perceiver perceiver1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDLANG
boolean sendlang(perceiver perceiver1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDLANG
boolean sendlang(perceiver perceiver1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16, perceivable perceivable17)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
perceivable17 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDLOC
boolean sendloc(location location, text text)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text text, perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text text, perceivable perceivable1, perceivable perceivable2)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5, perceivable perceivable6)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
perceivable6 | perceivable | a perceivable to use dynamically in the echoes. use $6 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5, perceivable perceivable6, perceivable perceivable7)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
perceivable6 | perceivable | a perceivable to use dynamically in the echoes. use $6 to refer. |
perceivable7 | perceivable | a perceivable to use dynamically in the echoes. use $7 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5, perceivable perceivable6, perceivable perceivable7, perceivable perceivable8)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
perceivable6 | perceivable | a perceivable to use dynamically in the echoes. use $6 to refer. |
perceivable7 | perceivable | a perceivable to use dynamically in the echoes. use $7 to refer. |
perceivable8 | perceivable | a perceivable to use dynamically in the echoes. use $8 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text layer, text text)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text layer, text text, perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text layer, text text, perceivable perceivable1, perceivable perceivable2)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text layer, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text layer, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text layer, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text layer, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5, perceivable perceivable6)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
perceivable6 | perceivable | a perceivable to use dynamically in the echoes. use $6 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text layer, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5, perceivable perceivable6, perceivable perceivable7)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
perceivable6 | perceivable | a perceivable to use dynamically in the echoes. use $6 to refer. |
perceivable7 | perceivable | a perceivable to use dynamically in the echoes. use $7 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOC
boolean sendloc(location location, text layer, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5, perceivable perceivable6, perceivable perceivable7, perceivable perceivable8)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
perceivable6 | perceivable | a perceivable to use dynamically in the echoes. use $6 to refer. |
perceivable7 | perceivable | a perceivable to use dynamically in the echoes. use $7 to refer. |
perceivable8 | perceivable | a perceivable to use dynamically in the echoes. use $8 to refer. |
This function sends a specified message to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOCFIXED
boolean sendlocfixed(location location, text text)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
This function sends a specified message to every perceiver in the location - the format is fixed, it does not wrap / process in any way. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOCFIXED
boolean sendlocfixed(location location, text text, perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
This function sends a specified message to every perceiver in the location - the format is fixed, it does not wrap / process in any way. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOCFIXED
boolean sendlocfixed(location location, text text, perceivable perceivable1, perceivable perceivable2)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
This function sends a specified message to every perceiver in the location - the format is fixed, it does not wrap / process in any way. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOCFIXED
boolean sendlocfixed(location location, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
This function sends a specified message to every perceiver in the location - the format is fixed, it does not wrap / process in any way. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOCFIXED
boolean sendlocfixed(location location, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
This function sends a specified message to every perceiver in the location - the format is fixed, it does not wrap / process in any way. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOCFIXED
boolean sendlocfixed(location location, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
This function sends a specified message to every perceiver in the location - the format is fixed, it does not wrap / process in any way. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOCFIXED
boolean sendlocfixed(location location, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5, perceivable perceivable6)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
perceivable6 | perceivable | a perceivable to use dynamically in the echoes. use $6 to refer. |
This function sends a specified message to every perceiver in the location - the format is fixed, it does not wrap / process in any way. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOCFIXED
boolean sendlocfixed(location location, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5, perceivable perceivable6, perceivable perceivable7)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
perceivable6 | perceivable | a perceivable to use dynamically in the echoes. use $6 to refer. |
perceivable7 | perceivable | a perceivable to use dynamically in the echoes. use $7 to refer. |
This function sends a specified message to every perceiver in the location - the format is fixed, it does not wrap / process in any way. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOCFIXED
boolean sendlocfixed(location location, text text, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5, perceivable perceivable6, perceivable perceivable7, perceivable perceivable8)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
perceivable6 | perceivable | a perceivable to use dynamically in the echoes. use $6 to refer. |
perceivable7 | perceivable | a perceivable to use dynamically in the echoes. use $7 to refer. |
perceivable8 | perceivable | a perceivable to use dynamically in the echoes. use $8 to refer. |
This function sends a specified message to every perceiver in the location - the format is fixed, it does not wrap / process in any way. You can use the colour tags (#0, #1 etc) in this echo.
SENDLOCLANG
boolean sendloclang(location location, text text, language language, accent accent)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANG
boolean sendloclang(location location, text text, language language, accent accent, perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANG
boolean sendloclang(location location, text text, language language, accent accent, perceivable perceivable1, perceivable perceivable2)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANG
boolean sendloclang(location location, text text, language language, accent accent, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANG
boolean sendloclang(location location, text text, language language, accent accent, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANG
boolean sendloclang(location location, text text, language language, accent accent, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANG
boolean sendloclang(location location, text text, language language, accent accent, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5, perceivable perceivable6)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
perceivable6 | perceivable | a perceivable to use dynamically in the echoes. use $6 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANG
boolean sendloclang(location location, text text, language language, accent accent, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5, perceivable perceivable6, perceivable perceivable7)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
perceivable6 | perceivable | a perceivable to use dynamically in the echoes. use $6 to refer. |
perceivable7 | perceivable | a perceivable to use dynamically in the echoes. use $7 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANG
boolean sendloclang(location location, text text, language language, accent accent, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5, perceivable perceivable6, perceivable perceivable7, perceivable perceivable8)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
perceivable6 | perceivable | a perceivable to use dynamically in the echoes. use $6 to refer. |
perceivable7 | perceivable | a perceivable to use dynamically in the echoes. use $7 to refer. |
perceivable8 | perceivable | a perceivable to use dynamically in the echoes. use $8 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANGLAYER
boolean sendloclanglayer(location location, text layer, text text, language language, accent accent)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANGLAYER
boolean sendloclanglayer(location location, text layer, text text, language language, accent accent, perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANGLAYER
boolean sendloclanglayer(location location, text layer, text text, language language, accent accent, perceivable perceivable1, perceivable perceivable2)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANGLAYER
boolean sendloclanglayer(location location, text layer, text text, language language, accent accent, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANGLAYER
boolean sendloclanglayer(location location, text layer, text text, language language, accent accent, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANGLAYER
boolean sendloclanglayer(location location, text layer, text text, language language, accent accent, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANGLAYER
boolean sendloclanglayer(location location, text layer, text text, language language, accent accent, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5, perceivable perceivable6)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
perceivable6 | perceivable | a perceivable to use dynamically in the echoes. use $6 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANGLAYER
boolean sendloclanglayer(location location, text layer, text text, language language, accent accent, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5, perceivable perceivable6, perceivable perceivable7)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
perceivable6 | perceivable | a perceivable to use dynamically in the echoes. use $6 to refer. |
perceivable7 | perceivable | a perceivable to use dynamically in the echoes. use $7 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDLOCLANGLAYER
boolean sendloclanglayer(location location, text layer, text text, language language, accent accent, perceivable perceivable1, perceivable perceivable2, perceivable perceivable3, perceivable perceivable4, perceivable perceivable5, perceivable perceivable6, perceivable perceivable7, perceivable perceivable8)
Parameter | Variable Type | Parameter Help |
location | location | the location to send the message to |
layer | text | the layer to send the message to |
text | text | the message to send to the location |
language | language | the language that the language content of the message should be understood in |
accent | accent | the spoken accent of the language content of the message |
perceivable1 | perceivable | a perceivable to use dynamically in the echoes. use $1 to refer. |
perceivable2 | perceivable | a perceivable to use dynamically in the echoes. use $2 to refer. |
perceivable3 | perceivable | a perceivable to use dynamically in the echoes. use $3 to refer. |
perceivable4 | perceivable | a perceivable to use dynamically in the echoes. use $4 to refer. |
perceivable5 | perceivable | a perceivable to use dynamically in the echoes. use $5 to refer. |
perceivable6 | perceivable | a perceivable to use dynamically in the echoes. use $6 to refer. |
perceivable7 | perceivable | a perceivable to use dynamically in the echoes. use $7 to refer. |
perceivable8 | perceivable | a perceivable to use dynamically in the echoes. use $8 to refer. |
This function sends a specified message (including potentially language/accent bound spoken information) to every perceiver in the location. You can use the colour tags (#0, #1 etc) in this echo. Anything inside double quotes will be interpreted as language.
SENDSHARD
boolean sendshard(shard shard1, text text1)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
SENDSHARD
boolean sendshard(shard shard1, text text1, perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARD
boolean sendshard(shard shard1, text text1, perceivable perceivable1, perceivable perceivable11)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARD
boolean sendshard(shard shard1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARD
boolean sendshard(shard shard1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARD
boolean sendshard(shard shard1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARD
boolean sendshard(shard shard1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARD
boolean sendshard(shard shard1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARD
boolean sendshard(shard shard1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16, perceivable perceivable17)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
perceivable17 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDFIXED
boolean sendshardfixed(shard shard1, text text1)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
SENDSHARDFIXED
boolean sendshardfixed(shard shard1, text text1, perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDFIXED
boolean sendshardfixed(shard shard1, text text1, perceivable perceivable1, perceivable perceivable11)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDFIXED
boolean sendshardfixed(shard shard1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDFIXED
boolean sendshardfixed(shard shard1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDFIXED
boolean sendshardfixed(shard shard1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDFIXED
boolean sendshardfixed(shard shard1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDFIXED
boolean sendshardfixed(shard shard1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDFIXED
boolean sendshardfixed(shard shard1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16, perceivable perceivable17)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
perceivable17 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDLANG
boolean sendshardlang(shard shard1, text text1, language language1, accent accent1)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
This function has no general help information.
SENDSHARDLANG
boolean sendshardlang(shard shard1, text text1, language language1, accent accent1, perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDLANG
boolean sendshardlang(shard shard1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDLANG
boolean sendshardlang(shard shard1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDLANG
boolean sendshardlang(shard shard1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDLANG
boolean sendshardlang(shard shard1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDLANG
boolean sendshardlang(shard shard1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDLANG
boolean sendshardlang(shard shard1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDSHARDLANG
boolean sendshardlang(shard shard1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16, perceivable perceivable17)
Parameter | Variable Type | Parameter Help |
shard1 | shard | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
perceivable17 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONE
boolean sendzone(zone zone1, text text1)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
SENDZONE
boolean sendzone(zone zone1, text text1, perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONE
boolean sendzone(zone zone1, text text1, perceivable perceivable1, perceivable perceivable11)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONE
boolean sendzone(zone zone1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONE
boolean sendzone(zone zone1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONE
boolean sendzone(zone zone1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONE
boolean sendzone(zone zone1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONE
boolean sendzone(zone zone1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONE
boolean sendzone(zone zone1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16, perceivable perceivable17)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
perceivable17 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONEFIXED
boolean sendzonefixed(zone zone1, text text1)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
SENDZONEFIXED
boolean sendzonefixed(zone zone1, text text1, perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONEFIXED
boolean sendzonefixed(zone zone1, text text1, perceivable perceivable1, perceivable perceivable11)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONEFIXED
boolean sendzonefixed(zone zone1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONEFIXED
boolean sendzonefixed(zone zone1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONEFIXED
boolean sendzonefixed(zone zone1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONEFIXED
boolean sendzonefixed(zone zone1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONEFIXED
boolean sendzonefixed(zone zone1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONEFIXED
boolean sendzonefixed(zone zone1, text text1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16, perceivable perceivable17)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
perceivable17 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONELANG
boolean sendzonelang(zone zone1, text text1, language language1, accent accent1)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
This function has no general help information.
SENDZONELANG
boolean sendzonelang(zone zone1, text text1, language language1, accent accent1, perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONELANG
boolean sendzonelang(zone zone1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONELANG
boolean sendzonelang(zone zone1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONELANG
boolean sendzonelang(zone zone1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONELANG
boolean sendzonelang(zone zone1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONELANG
boolean sendzonelang(zone zone1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONELANG
boolean sendzonelang(zone zone1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
This function has no general help information.
SENDZONELANG
boolean sendzonelang(zone zone1, text text1, language language1, accent accent1, perceivable perceivable1, perceivable perceivable11, perceivable perceivable12, perceivable perceivable13, perceivable perceivable14, perceivable perceivable15, perceivable perceivable16, perceivable perceivable17)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
text1 | text | this parameter has no help information. |
language1 | language | this parameter has no help information. |
accent1 | accent | this parameter has no help information. |
perceivable1 | perceivable | this parameter has no help information. |
perceivable11 | perceivable | this parameter has no help information. |
perceivable12 | perceivable | this parameter has no help information. |
perceivable13 | perceivable | this parameter has no help information. |
perceivable14 | perceivable | this parameter has no help information. |
perceivable15 | perceivable | this parameter has no help information. |
perceivable16 | perceivable | this parameter has no help information. |
perceivable17 | perceivable | this parameter has no help information. |
This function has no general help information.
SET
boolean set(void dictionary dictionary, text key, collectionitem item)
Parameter | Variable Type | Parameter Help |
dictionary | void dictionary | the dictionary you want to set the item in |
key | text | the text key at which you want to store that item |
item | collectionitem | the item that you want to add to the dictionary |
Sets the specified text key in the dictionary to be the item specified. Returns true if the set succeeded (the types were compatible), and false if not.
SETACCEPTSDOOR
exit setacceptsdoor(exit exit1, overlaypackage overlaypackage1, boolean boolean1, number number1)
Parameter | Variable Type | Parameter Help |
exit1 | exit | this parameter has no help information. |
overlaypackage1 | overlaypackage | this parameter has no help information. |
boolean1 | boolean | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
SETATMOSPHERE
boolean setatmosphere(location room, overlaypackage package, number gas)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to edit |
package | overlaypackage | the package that the edit belongs to |
gas | number | the id number of the gas you want to set as the atmosphere here |
Sets the atmosphere of a room as if you had done CELL SET ATMOSPHERE.
SETATMOSPHERE
boolean setatmosphere(location room, overlaypackage package, text gas)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to edit |
package | overlaypackage | the package that the edit belongs to |
gas | text | the name of the gas you want to set as the atmosphere here |
Sets the atmosphere of a room as if you had done CELL SET ATMOSPHERE.
SETATMOSPHERELIQUID
boolean setatmosphereliquid(location room, overlaypackage package, number liquid)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to edit |
package | overlaypackage | the package that the edit belongs to |
liquid | number | the id number of the liquid you want to set as the atmosphere here |
Sets the atmosphere of a room as if you had done CELL SET ATMOSPHERE.
SETATMOSPHERELIQUID
boolean setatmosphereliquid(location room, overlaypackage package, text liquid)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to edit |
package | overlaypackage | the package that the edit belongs to |
liquid | text | the name of the liquid you want to set as the atmosphere here |
Sets the atmosphere of a room as if you had done CELL SET ATMOSPHERE.
SETCELLADDEDLIGHT
boolean setcelladdedlight(location room, overlaypackage package, number light)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to edit |
package | overlaypackage | the package that the edit belongs to |
light | number | the added light in lux |
Sets the added light level of a room as if you had done CELL SET LIGHTLEVEL.
SETCELLLIGHTMULTIPLIER
boolean setcelllightmultiplier(location room, overlaypackage package, number multiplier)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to edit |
package | overlaypackage | the package that the edit belongs to |
multiplier | number | a multiplier for natural light levels - 1.0 = full natural light, 0.0 = no natural light |
Sets the light level multiplier of a room as if you had done CELL SET LIGHTMULTIPLIER.
SETCHARACTERISTIC
boolean setcharacteristic(character character, number definition, number value)
Parameter | Variable Type | Parameter Help |
character | character | the character whose characteristics you want to set |
definition | number | the id number of the characteristic definition you want to use |
value | number | the id number of the characteristic value that you want to set |
Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.
SETCHARACTERISTIC
boolean setcharacteristic(character character, text definition, number value)
Parameter | Variable Type | Parameter Help |
character | character | the character whose characteristics you want to set |
definition | text | the name of the characteristic definition you want to use |
value | number | the id number of the characteristic value that you want to set |
Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.
SETCHARACTERISTIC
boolean setcharacteristic(character character, number definition, text value)
Parameter | Variable Type | Parameter Help |
character | character | the character whose characteristics you want to set |
definition | number | the id number of the characteristic definition you want to use |
value | text | the name of the characteristic value that you want to set |
Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.
SETCHARACTERISTIC
boolean setcharacteristic(character character, text definition, text value)
Parameter | Variable Type | Parameter Help |
character | character | the character whose characteristics you want to set |
definition | text | the name of the characteristic definition you want to use |
value | text | the name of the characteristic value that you want to set |
Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.
SETCHARACTERISTIC
boolean setcharacteristic(item item, number definition, number value)
Parameter | Variable Type | Parameter Help |
item | item | the item whose characteristics you want to set |
definition | number | the id number of the characteristic definition you want to use |
value | number | the id number of the characteristic value that you want to set |
Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.
SETCHARACTERISTIC
boolean setcharacteristic(item item, text definition, number value)
Parameter | Variable Type | Parameter Help |
item | item | the item whose characteristics you want to set |
definition | text | the name of the characteristic definition you want to use |
value | number | the id number of the characteristic value that you want to set |
Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.
SETCHARACTERISTIC
boolean setcharacteristic(item item, number definition, text value)
Parameter | Variable Type | Parameter Help |
item | item | the item whose characteristics you want to set |
definition | number | the id number of the characteristic definition you want to use |
value | text | the name of the characteristic value that you want to set |
Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.
SETCHARACTERISTIC
boolean setcharacteristic(item item, text definition, text value)
Parameter | Variable Type | Parameter Help |
item | item | the item whose characteristics you want to set |
definition | text | the name of the characteristic definition you want to use |
value | text | the name of the characteristic value that you want to set |
Sets the intrinsic characteristic value for the characteristic definition on the supplied target. Returns true if successful.
SETCHARACTERISTICRANDOM
boolean setcharacteristicrandom(character character, number definition, number profile, boolean forcenew)
Parameter | Variable Type | Parameter Help |
character | character | the character whose characteristics you want to randomly set |
definition | number | the id number of the characteristic definition you want to use |
profile | number | the id number of the characteristic profile that you want to use to give the range of possible values |
forcenew | boolean | if true, excludes the current result from the outcome. i.e. the value must change. if false or if there is only 1 value to choose from on the profile, the result may still be the old value |
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.
SETCHARACTERISTICRANDOM
boolean setcharacteristicrandom(character character, text definition, number profile, boolean forcenew)
Parameter | Variable Type | Parameter Help |
character | character | the character whose characteristics you want to randomly set |
definition | text | the name of the characteristic definition you want to use |
profile | number | the id number of the characteristic profile that you want to use to give the range of possible values |
forcenew | boolean | if true, excludes the current result from the outcome. i.e. the value must change. if false or if there is only 1 value to choose from on the profile, the result may still be the old value |
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.
SETCHARACTERISTICRANDOM
boolean setcharacteristicrandom(character character, number definition, text profile, boolean forcenew)
Parameter | Variable Type | Parameter Help |
character | character | the character whose characteristics you want to randomly set |
definition | number | the id number of the characteristic definition you want to use |
profile | text | the name of the characteristic profile that you want to use to give the range of possible values |
forcenew | boolean | if true, excludes the current result from the outcome. i.e. the value must change. if false or if there is only 1 value to choose from on the profile, the result may still be the old value |
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.
SETCHARACTERISTICRANDOM
boolean setcharacteristicrandom(character character, text definition, text profile, boolean forcenew)
Parameter | Variable Type | Parameter Help |
character | character | the character whose characteristics you want to randomly set |
definition | text | the name of the characteristic definition you want to use |
profile | text | the name of the characteristic profile that you want to use to give the range of possible values |
forcenew | boolean | if true, excludes the current result from the outcome. i.e. the value must change. if false or if there is only 1 value to choose from on the profile, the result may still be the old value |
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.
SETCHARACTERISTICRANDOM
boolean setcharacteristicrandom(item item, number definition, number profile, boolean forcenew)
Parameter | Variable Type | Parameter Help |
item | item | the item whose characteristics you want to randomly set |
definition | number | the id number of the characteristic definition you want to use |
profile | number | the id number of the characteristic profile that you want to use to give the range of possible values |
forcenew | boolean | if true, excludes the current result from the outcome. i.e. the value must change. if false or if there is only 1 value to choose from on the profile, the result may still be the old value |
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.
SETCHARACTERISTICRANDOM
boolean setcharacteristicrandom(item item, text definition, number profile, boolean forcenew)
Parameter | Variable Type | Parameter Help |
item | item | the item whose characteristics you want to randomly set |
definition | text | the name of the characteristic definition you want to use |
profile | number | the id number of the characteristic profile that you want to use to give the range of possible values |
forcenew | boolean | if true, excludes the current result from the outcome. i.e. the value must change. if false or if there is only 1 value to choose from on the profile, the result may still be the old value |
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.
SETCHARACTERISTICRANDOM
boolean setcharacteristicrandom(item item, number definition, text profile, boolean forcenew)
Parameter | Variable Type | Parameter Help |
item | item | the item whose characteristics you want to randomly set |
definition | number | the id number of the characteristic definition you want to use |
profile | text | the name of the characteristic profile that you want to use to give the range of possible values |
forcenew | boolean | if true, excludes the current result from the outcome. i.e. the value must change. if false or if there is only 1 value to choose from on the profile, the result may still be the old value |
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.
SETCHARACTERISTICRANDOM
boolean setcharacteristicrandom(item item, text definition, text profile, boolean forcenew)
Parameter | Variable Type | Parameter Help |
item | item | the item whose characteristics you want to randomly set |
definition | text | the name of the characteristic definition you want to use |
profile | text | the name of the characteristic profile that you want to use to give the range of possible values |
forcenew | boolean | if true, excludes the current result from the outcome. i.e. the value must change. if false or if there is only 1 value to choose from on the profile, the result may still be the old value |
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.
SETCLIMB
exit setclimb(exit exit1, overlaypackage overlaypackage1, boolean boolean1, number number1)
Parameter | Variable Type | Parameter Help |
exit1 | exit | this parameter has no help information. |
overlaypackage1 | overlaypackage | this parameter has no help information. |
boolean1 | boolean | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
SETEXITSIZE
exit setexitsize(exit exit1, overlaypackage overlaypackage1, number number1, number number11)
Parameter | Variable Type | Parameter Help |
exit1 | exit | this parameter has no help information. |
overlaypackage1 | overlaypackage | this parameter has no help information. |
number1 | number | this parameter has no help information. |
number11 | number | this parameter has no help information. |
This function has no general help information.
SETEXITSLOWDOWN
exit setexitslowdown(exit exit1, overlaypackage overlaypackage1, number number1)
Parameter | Variable Type | Parameter Help |
exit1 | exit | this parameter has no help information. |
overlaypackage1 | overlaypackage | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
SETFALL
exit setfall(exit exit1, overlaypackage overlaypackage1, location location1)
Parameter | Variable Type | Parameter Help |
exit1 | exit | this parameter has no help information. |
overlaypackage1 | overlaypackage | this parameter has no help information. |
location1 | location | this parameter has no help information. |
This function has no general help information.
SETFLIPPED
boolean setflipped(item item, boolean flipped)
Parameter | Variable Type | Parameter Help |
item | item | the item that you want to flip or unflip |
flipped | boolean | a boolean representing whether this item is flipped or not |
If an item is a flippable (e.g. a table), this command sets the flipped state according to an argument you pass in. Returns true if the item was changed, false if it was already in the desired state or wasn't a flippable.
SETHEARINGPROFILE
boolean sethearingprofile(location room, overlaypackage package, number profile)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to edit |
package | overlaypackage | the package that the edit belongs to |
profile | number | the id number of the hearing profile to use |
Sets the hearing profile of the room as if you had done CELL SET HEARING.
SETHEARINGPROFILE
boolean sethearingprofile(location room, overlaypackage package, text profile)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to edit |
package | overlaypackage | the package that the edit belongs to |
profile | text | the name of the hearing profile to use |
Sets the hearing profile of the room as if you had done CELL SET HEARING.
SETINDOORS
boolean setindoors(location room, overlaypackage package)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to edit |
package | overlaypackage | the package that the edit belongs to |
Sets the indoors-type of the room to 'Indoors', as if you had done CELL SET TYPE INDOORS.
SETINDOORSCLIMATEEXPOSED
boolean setindoorsclimateexposed(location room, overlaypackage package)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to edit |
package | overlaypackage | the package that the edit belongs to |
Sets the indoors-type of the room to 'Indoors But Climate Exposed', as if you had done CELL SET TYPE EXPOSED.
SETINDOORSNOLIGHT
boolean setindoorsnolight(location room, overlaypackage package)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to edit |
package | overlaypackage | the package that the edit belongs to |
Sets the indoors-type of the room to 'Indoors With No Light', as if you had done CELL SET TYPE CAVE.
SETINDOORSWITHWINDOWS
boolean setindoorswithwindows(location room, overlaypackage package)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to edit |
package | overlaypackage | the package that the edit belongs to |
Sets the indoors-type of the room to 'Indoors With Windows', as if you had done CELL SET TYPE WINDOWS.
SETLAYER
boolean setlayer(character character, text layer)
Parameter | Variable Type | Parameter Help |
character | character | the character whose location you are setting |
layer | text | the layer to change them to |
This function changes the layer a character is currently at. Returns true if successful. See the ROOMLAYERS function for information on how to determine what layers are present.
SETLAYER
boolean setlayer(item item, text layer)
Parameter | Variable Type | Parameter Help |
item | item | the item whose location you are setting |
layer | text | the layer to change them to |
This function changes the layer an item is currently at. Returns true if successful. See the ROOMLAYERS function for information on how to determine what layers are present.
SETLIQUID
boolean setliquid(item item1, number number1)
Parameter | Variable Type | Parameter Help |
item1 | item | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
SETLIT
boolean setlit(item item1, boolean boolean1)
Parameter | Variable Type | Parameter Help |
item1 | item | this parameter has no help information. |
boolean1 | boolean | this parameter has no help information. |
This function has no general help information.
SETLOCKED
boolean setlocked(item item1, boolean boolean1, boolean boolean11)
Parameter | Variable Type | Parameter Help |
item1 | item | this parameter has no help information. |
boolean1 | boolean | this parameter has no help information. |
boolean11 | boolean | this parameter has no help information. |
This function has no general help information.
SETMATERIAL
boolean setmaterial(item item, solid material)
Parameter | Variable Type | Parameter Help |
item | item | the item whose primary material you want to set |
material | solid | the material you want to set |
This function sets the primary material of an item to the specified material. It returns true if this succeeds.
SETMATERIAL
boolean setmaterial(item item, number material)
Parameter | Variable Type | Parameter Help |
item | item | the item whose primary material you want to set |
material | number | the id of the material that you want to set |
This function sets the primary material of an item to the specified material. It returns true if this succeeds.
SETMATERIAL
boolean setmaterial(item item, text material)
Parameter | Variable Type | Parameter Help |
item | item | the item whose primary material you want to set |
material | text | the name of the material that you want to set |
This function sets the primary material of an item to the specified material. It returns true if this succeeds.
SETMORPHTIMER
boolean setmorphtimer(item item, timespan timer)
Parameter | Variable Type | Parameter Help |
item | item | the item who's morph timer you want to set |
timer | timespan | the amount of time from now you want the morph timer to expire in |
This function allows you to set the morph timer on an item, overwriting whatever it currently is and setting it if it doesn't have one. What happens depends on the prototype. If an item is not set to morph normally, this can still make it morph but most likely morph to nothing. Returns false if anything went wrong like passed a null item.
SETMORPHTIMER
boolean setmorphtimer(item item, number timer)
Parameter | Variable Type | Parameter Help |
item | item | the item who's morph timer you want to set |
timer | number | a number of seconds from now you want the morph timer to expire in |
This function allows you to set the morph timer on an item, overwriting whatever it currently is and setting it if it doesn't have one. What happens depends on the prototype. If an item is not set to morph normally, this can still make it morph but most likely morph to nothing. Returns false if anything went wrong like passed a null item.
SETON
boolean seton(item item1, boolean boolean1, boolean boolean11)
Parameter | Variable Type | Parameter Help |
item1 | item | this parameter has no help information. |
boolean1 | boolean | this parameter has no help information. |
boolean11 | boolean | this parameter has no help information. |
This function has no general help information.
SETOPEN
boolean setopen(item item1, boolean boolean1, boolean boolean11)
Parameter | Variable Type | Parameter Help |
item1 | item | this parameter has no help information. |
boolean1 | boolean | this parameter has no help information. |
boolean11 | boolean | this parameter has no help information. |
This function has no general help information.
SETOUTDOORS
boolean setoutdoors(location room, overlaypackage package)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to edit |
package | overlaypackage | the package that the edit belongs to |
Sets the indoors-type of the room to 'Outdoors', as if you had done CELL SET TYPE OUTDOORS.
SETOUTFITDESCRIPTION
outfit setoutfitdescription(outfit outfit1, text text1)
Parameter | Variable Type | Parameter Help |
outfit1 | outfit | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
SETPROVIDINGCOVER
boolean setprovidingcover(item item1, boolean boolean1)
Parameter | Variable Type | Parameter Help |
item1 | item | this parameter has no help information. |
boolean1 | boolean | this parameter has no help information. |
This function has no general help information.
SETQUALITY
boolean setquality(item item, number quality)
Parameter | Variable Type | Parameter Help |
item | item | the item whose quality you wish to set |
quality | number | the quality of the item. 0 = terribly, 11 = legendary |
This function sets the quality of an item to whatever quality you specify.
SETQUALITY
boolean setquality(item item, text quality)
Parameter | Variable Type | Parameter Help |
item | item | the item whose quality you wish to set |
quality | text | the quality of the item. valid qualities are terrible, extremely bad, bad, poor, substandard, standard, good, very good, great, excellent, heroic, legendary. |
This function sets the quality of an item to whatever quality you specify.
SETTERRAIN
boolean setterrain(location room, overlaypackage package, terrain terrain)
Parameter | Variable Type | Parameter Help |
room | location | the room you want to edit |
package | overlaypackage | the package that the edit belongs to |
terrain | terrain | the terrain to set |
Sets the terrain type of a room as if you had done CELL SET TERRAIN.
SETVENDINGBALANCE
boolean setvendingbalance(item item1, number number1)
Parameter | Variable Type | Parameter Help |
item1 | item | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
SILENTDROP
boolean silentdrop(character character1, item item1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
This function has no general help information.
SILENTGET
boolean silentget(character character1, item item1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
This function has no general help information.
SILENTGET
boolean silentget(character character1, item item1, number number1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
SILENTGET
boolean silentget(character character1, item item1, item item11)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
item11 | item | this parameter has no help information. |
This function has no general help information.
SILENTGET
boolean silentget(character character1, item item1, item item11, number number1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
item11 | item | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
SILENTPUT
boolean silentput(character character1, item item1, item item11)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
item11 | item | this parameter has no help information. |
This function has no general help information.
SILENTREMOVE
boolean silentremove(character character1, item item1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
This function has no general help information.
SILENTUNWIELD
boolean silentunwield(character character1, item item1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
This function has no general help information.
SILENTWEAR
boolean silentwear(character character1, item item1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
This function has no general help information.
SILENTWIELD
boolean silentwield(character character1, item item1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
This function has no general help information.
SPLITCOMMODITY
item splitcommodity(item item, number weight)
Parameter | Variable Type | Parameter Help |
item | item | the item to take the weight from |
weight | number | the weight of the material to split off in base units for this mud. see mud owner for configuration info |
This function takes weight from one commodity pile and creates a new commodity pile item with the taken weight, which it then returns. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory. If the quantity is the whole weight of the original item or larger, it will just return the original item and no new item will be created.
SPLITCOMMODITY
item splitcommodity(item item, text weight)
Parameter | Variable Type | Parameter Help |
item | item | the item to take the weight from |
weight | text | the weight of the material to split off, e.g. 120kg, 15lb 3oz, etc |
This function takes weight from one commodity pile and creates a new commodity pile item with the taken weight, which it then returns. It does not put the item anywhere, so you must then insert it somewhere like in a room or a character's inventory. If the quantity is the whole weight of the original item or larger, it will just return the original item and no new item will be created.
STARTCOMBAT
boolean startcombat(text reference, text description, text gerund, boolean friendly, character combatant1, character combatant2, text joinprog, text leaveprog, text endprog, text moveprog, text hitprog)
Parameter | Variable Type | Parameter Help |
reference | text | a unique reference that is passed to each of the progs when executed |
description | text | the description of the combat that appears in combat status |
gerund | text | the gerund used in combat descriptions, e.g. fighting, sparring, boxing, etc. |
friendly | boolean | whether this combat counts as friendly and uses the spar rules or not |
combatant1 | character | the first combatant |
combatant2 | character | the second combatant |
joinprog | text | a prog to execute when someone joins the combat. it must accept a character (the joiner) and a text parameter (the reference). |
leaveprog | text | a prog to execute when someone leaves the combat. it must accept a character (the leaver) and a text parameter (the reference). |
endprog | text | a prog to execute when the combat ends. it must accept a text parameter (the reference). |
moveprog | text | a prog to execute when someone makes a move in combat. it must accept a character (the attacker), another character (the target) and a text parameter (the reference). |
hitprog | text | a prog to execute when someone hits someone in combat. it must accept a character (the attacker), another character (the target) and a text parameter (the reference). |
Starts a combat that executes progs when various things happen.
SWAPOUTFITITEMS
boolean swapoutfititems(outfit outfit1, outfititem outfititem1, outfititem outfititem11)
Parameter | Variable Type | Parameter Help |
outfit1 | outfit | this parameter has no help information. |
outfititem1 | outfititem | this parameter has no help information. |
outfititem11 | outfititem | this parameter has no help information. |
This function has no general help information.
SWAPOVERLAY
boolean swapoverlay(number overlay)
Parameter | Variable Type | Parameter Help |
overlay | number | the id number of the overlay you want to swap |
Swaps an approved overlay into the worldfile as if you had run the CELL SWAP command. Returns true if successful.
SWAPOVERLAY
boolean swapoverlay(text overlay)
Parameter | Variable Type | Parameter Help |
overlay | text | the name of the overlay you want to swap |
Swaps an approved overlay into the worldfile as if you had run the CELL SWAP command. Returns true if successful.
SWAPOVERLAY
boolean swapoverlay(number overlay, location room)
Parameter | Variable Type | Parameter Help |
overlay | number | the id number of the overlay you want to swap |
room | location | the room you want to swap this package in for only |
Swaps an approved overlay for one room only into the worldfile as if you had run the CELL SWAP command. Returns true if successful. This use case is only recommended for advanced scenarios - in most cases you should swap the entire overlay in at once
SWAPOVERLAY
boolean swapoverlay(text overlay, location room)
Parameter | Variable Type | Parameter Help |
overlay | text | the name of the overlay you want to swap |
room | location | the room you want to swap this package in for only |
Swaps an approved overlay for one room only into the worldfile as if you had run the CELL SWAP command. Returns true if successful. This use case is only recommended for advanced scenarios - in most cases you should swap the entire overlay in at once
SWAPOVERLAY
boolean swapoverlay(overlaypackage overlay)
Parameter | Variable Type | Parameter Help |
overlay | overlaypackage | the overlay package that you want to swap |
Swaps an approved overlay into the worldfile as if you had run the CELL SWAP command. Returns true if successful.
SWAPOVERLAY
boolean swapoverlay(overlaypackage overlay, location room)
Parameter | Variable Type | Parameter Help |
overlay | overlaypackage | the overlay package that you want to swap |
room | location | the room you want to swap this package in for only |
Swaps an approved overlay for one room only into the worldfile as if you had run the CELL SWAP command. Returns true if successful. This use case is only recommended for advanced scenarios - in most cases you should swap the entire overlay in at once
TAKE
item take(item item)
Parameter | Variable Type | Parameter Help |
item | item | the item to take |
Takes an item from its inventory or container. Returns the item.
TAKE
item take(item item, number quantity)
Parameter | Variable Type | Parameter Help |
item | item | the item to take |
quantity | number | the quantity to take. use 0 for all |
Takes an item from its inventory or container. Returns the new item, which may be the same as the original item if the quantity is equal to the existing quantity.
TAKECOMMODITY
boolean takecommodity(item item, number weight)
Parameter | Variable Type | Parameter Help |
item | item | the item to take the weight from |
weight | number | the weight of the material to take in base units for this mud. see mud owner for configuration info |
This function takes a certain weight off of a commodity pile. If the weight is equal to or higher than the weight of the commodity pile, it deletes the pile. Returns true if it succeeded at taking the weight.
TAKECOMMODITY
boolean takecommodity(item item, text weight)
Parameter | Variable Type | Parameter Help |
item | item | the item to take the weight from |
weight | text | the weight of the material to take, e.g. 120kg, 15lb 3oz, etc |
This function takes a certain weight off of a commodity pile. If the weight is equal to or higher than the weight of the commodity pile, it deletes the pile. Returns true if it succeeded at taking the weight.
TAKECURRENCY
boolean takecurrency(currency currency1, unknown type unknown type1, magicresourcehaver magicresourcehaver1, boolean boolean1, boolean boolean11)
Parameter | Variable Type | Parameter Help |
currency1 | currency | this parameter has no help information. |
unknown type1 | unknown type | this parameter has no help information. |
magicresourcehaver1 | magicresourcehaver | this parameter has no help information. |
boolean1 | boolean | this parameter has no help information. |
boolean11 | boolean | this parameter has no help information. |
This function has no general help information.
TAKEDELETE
item takedelete(item item)
Parameter | Variable Type | Parameter Help |
item | item | the item to take |
Takes an item from its inventory or container and deletes it. Returns null.
TAKEDELETE
item takedelete(item item, number quantity)
Parameter | Variable Type | Parameter Help |
item | item | the item to take |
quantity | number | the quantity to take. use 0 for all |
Takes an item from its inventory or container. Deletes the item and returns null.
TELEPORT
boolean teleport(character character, location destination)
Parameter | Variable Type | Parameter Help |
character | character | the character who you want to teleport |
destination | location | the destination room to teleport them to |
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).
TELEPORT
boolean teleport(character character, location destination, text layer)
Parameter | Variable Type | Parameter Help |
character | character | the character who you want to teleport |
destination | location | the destination room to teleport them to |
layer | text | the room layer to teleport to |
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).
TELEPORTNOECHO
boolean teleportnoecho(character character, location destination)
Parameter | Variable Type | Parameter Help |
character | character | the character who you want to teleport |
destination | location | the destination room to teleport them to |
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).
TELEPORTNOECHO
boolean teleportnoecho(character character, location destination, text layer)
Parameter | Variable Type | Parameter Help |
character | character | the character who you want to teleport |
destination | location | the destination room to teleport them to |
layer | text | the room layer to teleport to |
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).
TEMPFROMTEXT
number tempfromtext(text text1)
Parameter | Variable Type | Parameter Help |
text1 | text | this parameter has no help information. |
This function has no general help information.
TEXTFROMAREA
text textfromarea(number number1)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
This function has no general help information.
TEXTFROMFLUID
text textfromfluid(number number1)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
This function has no general help information.
TEXTFROMLENGTH
text textfromlength(number number1)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
This function has no general help information.
TEXTFROMMASS
text textfrommass(number number1)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
This function has no general help information.
TEXTFROMTEMP
text textfromtemp(number number1)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
This function has no general help information.
TEXTFROMVOLUME
text textfromvolume(number number1)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
This function has no general help information.
TEXTTABLE
text texttable(text collection headers, text collection values, number width)
Parameter | Variable Type | Parameter Help |
headers | text collection | a collection of text values to use as the headers of the table |
values | text collection | a collection of text values, each of which is a row, with columns separated by the tab (\t) character |
width | number | the width of the table |
This function displays a coloured 'text table', essentially an ASCII representation of a table. The number of columns in the header MUST match the number of columns in each row.
TEXTTABLE
text texttable(text headers, text collection values, number width)
Parameter | Variable Type | Parameter Help |
headers | text | text with values separated by tab characters (\t) to use as the headers of the table |
values | text collection | a collection of text values, each of which is a row, with columns separated by the tab (\t) character |
width | number | the width of the table |
This function displays a coloured 'text table', essentially an ASCII representation of a table. The number of columns in the header MUST match the number of columns in each row.
TIMEOFDAY
text timeofday(location location1)
Parameter | Variable Type | Parameter Help |
location1 | location | this parameter has no help information. |
This function has no general help information.
TIMEOFDAY
text timeofday(zone zone1)
Parameter | Variable Type | Parameter Help |
zone1 | zone | this parameter has no help information. |
This function has no general help information.
TOACCENT
accent toaccent(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOACCENT
accent toaccent(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOAPPOINTMENT
appointment toappointment(clan clan1, number number1)
Parameter | Variable Type | Parameter Help |
clan1 | clan | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
TOAPPOINTMENT
appointment toappointment(clan clan1, text text1)
Parameter | Variable Type | Parameter Help |
clan1 | clan | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
TOAPPOINTMENT
appointment toappointment(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOAPPOINTMENT
appointment toappointment(clan clan, text name)
Parameter | Variable Type | Parameter Help |
clan | clan | the clan in which you want to search |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOCHARACTER
character tocharacter(perceiver perceiver1)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
This function has no general help information.
TOCHARACTER
character tocharacter(perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
perceivable1 | perceivable | this parameter has no help information. |
This function has no general help information.
TOCHARACTER
character tocharacter(toon toon1)
Parameter | Variable Type | Parameter Help |
toon1 | toon | this parameter has no help information. |
This function has no general help information.
TOCHARACTER
character tocharacter(collectionitem collectionitem1)
Parameter | Variable Type | Parameter Help |
collectionitem1 | collectionitem | this parameter has no help information. |
This function has no general help information.
TOCLAN
clan toclan(number number1)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
This function has no general help information.
TOCLAN
clan toclan(text text1)
Parameter | Variable Type | Parameter Help |
text1 | text | this parameter has no help information. |
This function has no general help information.
TOCLAN
clan toclan(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOCLAN
clan toclan(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOCULTURE
culture toculture(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOCULTURE
culture toculture(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOCURRENCY
currency tocurrency(number number1)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
This function has no general help information.
TOCURRENCY
currency tocurrency(text text1)
Parameter | Variable Type | Parameter Help |
text1 | text | this parameter has no help information. |
This function has no general help information.
TODATE
datetime todate(text text1, text text11)
Parameter | Variable Type | Parameter Help |
text1 | text | this parameter has no help information. |
text11 | text | this parameter has no help information. |
This function has no general help information.
TODATE
muddatetime todate(calendar calendar1, clock clock1, text text1)
Parameter | Variable Type | Parameter Help |
calendar1 | calendar | this parameter has no help information. |
clock1 | clock | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
TODAY
datetime today()
Parameter | Variable Type | Parameter Help |
This function has no general help information.
TODRUG
drug todrug(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TODRUG
drug todrug(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOETHNICITY
ethnicity toethnicity(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOETHNICITY
ethnicity toethnicity(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOGENDER
gender togender(text gender)
Parameter | Variable Type | Parameter Help |
gender | text | the textual representation of the gender you want to load. |
This function takes some text and returns a gender based on the text. The valid genders are male, female, neuter, non-binary and indeterminate.
TOITEM
item toitem(perceiver perceiver1)
Parameter | Variable Type | Parameter Help |
perceiver1 | perceiver | this parameter has no help information. |
This function has no general help information.
TOITEM
item toitem(perceivable perceivable1)
Parameter | Variable Type | Parameter Help |
perceivable1 | perceivable | this parameter has no help information. |
This function has no general help information.
TOITEM
item toitem(collectionitem collectionitem1)
Parameter | Variable Type | Parameter Help |
collectionitem1 | collectionitem | this parameter has no help information. |
This function has no general help information.
TOKNOWLEDGE
knowledge toknowledge(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOKNOWLEDGE
knowledge toknowledge(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOLANGUAGE
language tolanguage(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOLANGUAGE
language tolanguage(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOLEGALAUTHORITY
legalauthority tolegalauthority(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOLEGALAUTHORITY
legalauthority tolegalauthority(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOLOCATION
location tolocation(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOLOCATION
location tolocation(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOMERIT
merit tomerit(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOMERIT
merit tomerit(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TONUMBER
number tonumber(text text1)
Parameter | Variable Type | Parameter Help |
text1 | text | this parameter has no help information. |
This function has no general help information.
TONUMBER
number tonumber(text text1, number number1)
Parameter | Variable Type | Parameter Help |
text1 | text | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
TONUMBERWORDS
text tonumberwords(number number1)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
This function has no general help information.
TOORDINAL
text toordinal(number number1)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
This function has no general help information.
TOORDINALWORDS
text toordinalwords(number number1)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
This function has no general help information.
TOOVERLAYPACKAGE
overlaypackage tooverlaypackage(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOOVERLAYPACKAGE
overlaypackage tooverlaypackage(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOOVERLAYPACKAGE
overlaypackage tooverlaypackage(number id, number revision)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
revision | number | the revision number to look up |
Converts an ID number into the specified type, if one exists
TOOVERLAYPACKAGE
overlaypackage tooverlaypackage(text name, number revision)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
revision | number | the revision number to look up |
Converts a name into the specified type, if one exists
TOPAYGRADE
paygrade topaygrade(clan clan1, number number1)
Parameter | Variable Type | Parameter Help |
clan1 | clan | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
TOPAYGRADE
paygrade topaygrade(clan clan1, text text1)
Parameter | Variable Type | Parameter Help |
clan1 | clan | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
TOPAYGRADE
paygrade topaygrade(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOPAYGRADE
paygrade topaygrade(clan clan, text name)
Parameter | Variable Type | Parameter Help |
clan | clan | the clan in which you want to search |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TORACE
race torace(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TORACE
race torace(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TORANK
rank torank(clan clan1, number number1)
Parameter | Variable Type | Parameter Help |
clan1 | clan | this parameter has no help information. |
number1 | number | this parameter has no help information. |
This function has no general help information.
TORANK
rank torank(clan clan1, text text1)
Parameter | Variable Type | Parameter Help |
clan1 | clan | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
TORANK
rank torank(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TORANK
rank torank(clan clan, text name)
Parameter | Variable Type | Parameter Help |
clan | clan | the clan in which you want to search |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOROLE
role torole(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOROLE
role torole(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOSHARD
shard toshard(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOSHARD
shard toshard(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOTERRAIN
terrain toterrain(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOTERRAIN
terrain toterrain(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOTEXT
text totext(datetime datetime1)
Parameter | Variable Type | Parameter Help |
datetime1 | datetime | this parameter has no help information. |
This function has no general help information.
TOTEXT
text totext(datetime datetime1, toon toon1)
Parameter | Variable Type | Parameter Help |
datetime1 | datetime | this parameter has no help information. |
toon1 | toon | this parameter has no help information. |
This function has no general help information.
TOTEXT
text totext(datetime datetime1, text text1, toon toon1)
Parameter | Variable Type | Parameter Help |
datetime1 | datetime | this parameter has no help information. |
text1 | text | this parameter has no help information. |
toon1 | toon | this parameter has no help information. |
This function has no general help information.
TOTEXT
text totext(muddatetime muddatetime1)
Parameter | Variable Type | Parameter Help |
muddatetime1 | muddatetime | this parameter has no help information. |
This function has no general help information.
TOTEXT
text totext(timespan timespan1)
Parameter | Variable Type | Parameter Help |
timespan1 | timespan | this parameter has no help information. |
This function has no general help information.
TOTEXT
text totext(timespan timespan1, toon toon1)
Parameter | Variable Type | Parameter Help |
timespan1 | timespan | this parameter has no help information. |
toon1 | toon | this parameter has no help information. |
This function has no general help information.
TOTEXT
text totext(number number1)
Parameter | Variable Type | Parameter Help |
number1 | number | this parameter has no help information. |
This function has no general help information.
TOTEXT
text totext(boolean boolean1)
Parameter | Variable Type | Parameter Help |
boolean1 | boolean | this parameter has no help information. |
This function has no general help information.
TOTEXTCRUDE
text totextcrude(muddatetime muddatetime1)
Parameter | Variable Type | Parameter Help |
muddatetime1 | muddatetime | this parameter has no help information. |
This function has no general help information.
TOTEXTSHORT
text totextshort(muddatetime muddatetime1)
Parameter | Variable Type | Parameter Help |
muddatetime1 | muddatetime | this parameter has no help information. |
This function has no general help information.
TOTEXTVAGUE
text totextvague(muddatetime muddatetime1)
Parameter | Variable Type | Parameter Help |
muddatetime1 | muddatetime | this parameter has no help information. |
This function has no general help information.
TOTEXTWORDY
text totextwordy(muddatetime muddatetime1)
Parameter | Variable Type | Parameter Help |
muddatetime1 | muddatetime | this parameter has no help information. |
This function has no general help information.
TOTRAIT
trait totrait(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOTRAIT
trait totrait(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
TOZONE
zone tozone(number id)
Parameter | Variable Type | Parameter Help |
id | number | the id to look up |
Converts an ID number into the specified type, if one exists
TOZONE
zone tozone(text name)
Parameter | Variable Type | Parameter Help |
name | text | the name to look up |
Converts a name into the specified type, if one exists
UNKNOWNCRIMES
crime collection unknowncrimes(character character, legalauthority authority)
Parameter | Variable Type | Parameter Help |
character | character | the character to fetch crimes for |
authority | legalauthority | the authority to check crimes in, or if null, all authorities |
Returns a list of all the unresolved crimes unknown to authorities in the specified authority (or authorities)
UNWIELD
boolean unwield(character character1, item item1, text text1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
VOLUMEFROMTEXT
number volumefromtext(text text1)
Parameter | Variable Type | Parameter Help |
text1 | text | this parameter has no help information. |
This function has no general help information.
WARNEDBYENFORCER
boolean warnedbyenforcer(character character)
Parameter | Variable Type | Parameter Help |
character | character | the character who you want to check for warnings |
This function checks if the character is currently under a warning to surrender from any enforcers
WEAR
boolean wear(character character1, item item1, text text1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
WEAROUTFIT
boolean wearoutfit(character character1, outfit outfit1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
outfit1 | outfit | this parameter has no help information. |
This function has no general help information.
WEAROUTFITFORCE
boolean wearoutfitforce(character character1, outfit outfit1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
outfit1 | outfit | this parameter has no help information. |
This function has no general help information.
WIELD
boolean wield(character character1, item item1, text text1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
item1 | item | this parameter has no help information. |
text1 | text | this parameter has no help information. |
This function has no general help information.
WILDANIMALHERDROLE
text wildanimalherdrole(character character1)
Parameter | Variable Type | Parameter Help |
character1 | character | this parameter has no help information. |
This function has no general help information.
WITHDRAWGRID
boolean withdrawgrid(number grid, location location)
Parameter | Variable Type | Parameter Help |
grid | number | the id of the grid you want to withdraw from |
location | location | the location you want to withdraw the grid from |
This function allows you to withdraw a grid (electrical, gas, liquid etc) from a new location. Returns true if the withdrawal happened, false implies the grid was not present or there was another error.