Lua Table Of Functions With Definitions

Main.LuaTableOfFunctionsWithDefinitions History

Hide minor edits - Show changes to markup

December 31, 2008, at 05:36 PM EST by admin
Changed lines 56-57 from:

give(give(ch,amount) Give experience to player 'ch'

to:

givegive(ch,amount) Give experience to player 'ch'

Changed lines 72-129 from:

isplayer Tests if ch is a player.

kill Attack another character.

mobflag Tests if mob has a flag set. Always false on a player.

mdo Causes the mob running the prog to execute a mud command.

mgoto Go to mob, if found.

mload Create an instance of mobkey and place it in the current room. Return mob created.

mobexists Tests if instances of mob exist, specific room or entire game.

movechar Transfer a character or group to another room from room progs.

1]) Test for, or set, flags on an item.

objingame Tests if instances of obj exist anywhere in game.

objhere Tests if instances of obj exist in current room.

oload Create an instance of an object in inventory or room. Return obj created.

peace Stops all combat on a given character, or on character running the prog.

pgoto Go to player, if found.

plrflag Tests if player has a specific flag set. Always false for mobs.

a mob to post a note from within lua progs.

purgemob Purge mob(s) in current room or in entire game.

purgeobj Purge various combinations of objects in room or game.

randchar Find a random charater in the current room. Return as ch type variable.

remember Remember 'ch' for use with delay triggers - mprog compability

rgoto Go to a specific room.

say Causes mob to say something to the room.

sayto Causes a "say" to be sent to single char and formatted for linebreaks. Used in Academy.

send Send a message to ch. Useful for debug and in progs where echo is not available.

social Causes the mob to execute a social.

summon Causes the character, if found, to be transferred to current room.

transfer Transfers character(s) already in the current room to another location.

wearsobj Tests if character has the item type worn. For compatibility with old mobprog conversions.

zecho Sends a message to all players in the current zone.

to:

isplayer isplayer(ch) Tests if ch is a player.

kill kill(ch,opts) Attack another character.

mobflag mobflag(ch,flag) Tests if mob has a flag set. Always false on a player.

mdo mdo(command) Causes the mob running the prog to execute a mud command.

mgoto mgoto(name)Go to mob, if found.

mload mload(mobkey) Create an instance of mobkey and place it in the current room. Return mob created.

mobexists mobexists(mobkey,room) Tests if instances of mob exist, specific room or entire game.

movechar movechar(ch,room,opts) Transfer a character or group to another room from room progs.

objflag objflag(obj,flag,[0|1]) Test for, or set, flags on an item.

objingame objingame(objkey)Tests if instances of obj exist anywhere in game.

objhere objhere(objkey) Tests if instances of obj exist in current room.

oload oload(mobkey) Create an instance of an object in inventory or room. Return obj created.

peace peace( ) Stops all combat on a given character, or on character running the prog.

pgoto pgoto(name)Go to player, if found.

plrflag plrflag(ch,flagname) Tests if player has a specific flag set. Always false for mobs.

postnote postnote(...) Allows a mob to post a note from within lua progs.

purgemob purgemob(ch,opts) Purge mob(s) in current room or in entire game.

purgeobj purgeobj(obj,opts) Purge various combinations of objects in room or game.

randchar randchar(opts) Find a random charater in the current room. Return as ch type variable.

remember remember(ch)Remember 'ch' for use with delay triggers - mprog compability

rgoto rgoto(roomkey)Go to a specific room.

say say(message)Causes mob to say something to the room.

sayto sayto(ch,message,opts) Causes a "say" to be sent to single char and formatted for linebreaks. Used in Academy.

send send(ch,message) Send a message to ch. Useful for debug and in progs where echo is not available.

social social(social,targ)Causes the mob to execute a social.

summon summon(ch,opts)Causes the character, if found, to be transferred to current room.

transfer transfer(ch,loc,opts) Transfers character(s) already in the current room to another location.

wearsobj wearsobj(ch,item) Tests if character has the item type worn. For compatibility with old mobprog conversions.

zecho zecho(message) Sends a message to all players in the current zone.

December 31, 2008, at 02:55 AM EST by admin
Changed lines 50-51 from:

obj|room,opts) getobj(objkey,ch|obj|room,opts} Find an object. Return as obj type.

to:

getobj getobj(objkey,ch|obj|room,opts} Find an object. Return as obj type.

Changed lines 56-57 from:

give give(ch,amount) Give experience to player 'ch'

to:

give(give(ch,amount) Give experience to player 'ch'

Changed lines 62-71 from:

hasdelay Tests whether the mob running the program has an old-style 'mob delay' set.

hasobj Tests if character has the item type carried. For compatibility with old mobprog conversions.

immune Tests if character is immune to a specific damage focus.

info Test or set value of an info channel setting.

off) Test or set value of an info channel setting.

to:

hasdelay hasdelay() Tests whether the mob running the program has an old-style 'mob delay' set.

hasobj hasobj(ch,item)Tests if character has the item type carried. For compatibility with old mobprog conversions.

immune immune(ch,focus) Tests if character is immune to a specific damage focus.

info info("message","channel") Test or set value of an info channel setting.

infoflag infoflag(ch1,"info chan",on|off) Test or set value of an info channel setting.

December 31, 2008, at 02:01 AM EST by admin
Changed lines 42-45 from:

emote Emote a message to the room.

force Force a character, or group of characters, to perform an action.

to:

emote emote(msg) Emote a message to the room.

force force(ch,commands,opts) Force a character, or group of characters, to perform an action.

Changed lines 48-61 from:

getmob Find a character in the game or a single room. Return as ch type.

obj|room,opts) Find an object. Return as obj type.

getroom Get room if roomkey exists, returned as room type variable.

give Give an item to character 'ch'

give Give experience to player 'ch'

giveqp Give quest points to player 'ch'

hasclass Tests whether CH has the given class.

to:

getmob getmob(mob,room,opts) Find a character in the game or a single room. Return as ch type.

obj|room,opts) getobj(objkey,ch|obj|room,opts} Find an object. Return as obj type.

getroom getroom(roomkey Get room if roomkey exists, returned as room type variable.

give give(item,ch) Give an item to character 'ch'

give give(ch,amount) Give experience to player 'ch'

giveqp giveqp(ch,amount) Give quest points to player 'ch'

hasclass hasclass(ch,[class]) Tests whether CH has the given class.

December 30, 2008, at 10:33 PM EST by admin
Changed lines 20-21 from:

castcast(spell,targ,opts) Casts a spell at the target given, or self.

to:

cast cast(spell,targ,opts) Casts a spell at the target given, or self.

Changed lines 34-35 from:

doatdoat(loc,action,opts) Mob performs an action in another room.

to:

doat doat(loc,action,opts) Mob performs an action in another room.

Changed lines 38-41 from:

echoatechoat(ch,about,opts) Echo a message to a specific character. $ variables available.

echoaroundechoaround(ch,about,opts) Echo a message to all rooms adjacent to ch.

to:

echoat echoat(ch,about,opts) Echo a message to a specific character. $ variables available.

echoaround echoaround(ch,about,opts) Echo a message to all rooms adjacent to ch.

December 30, 2008, at 10:33 PM EST by admin
Changed lines 18-41 from:

carries Test if ch1 is carrying item in their inventory

cast Casts a spell at the target given, or self.

clantalk Allows clan mobs and guards to talk on their channel.

off) Test or set value of a channel flag on a player.

off) Test or set value of a configuration flag on a player.

countitems Counts how many of a specific item a player is wearing and/or carrying.

Inflict damage on CH. See details for argument list.

destroy Destroy one of more instances of item [objkey] on CH.

doat Mob performs an action in another room.

echo Echo a message to CH, or about CH (to room). $ variables available.

echoat Echo a message to a specific character. $ variables available.

echoaround Echo a message to all rooms adjacent to ch.

to:

carries carries(ch1,item) Test if ch1 is carrying item in their inventory

castcast(spell,targ,opts) Casts a spell at the target given, or self.

clantalk clantalk(message) Allows clan mobs and guards to talk on their channel.

channel channel(ch1,"channel",on|off) Test or set value of a channel flag on a player.

config config(ch1,"flag",on|off)]] Test or set value of a configuration flag on a player.

countitems countitems(ch,item,opts)Counts how many of a specific item a player is wearing and/or carrying.

damage damage(...)Inflict damage on CH. See details for argument list.

destroy destroy(ch,obj,opts) Destroy one of more instances of item [objkey] on CH.

doatdoat(loc,action,opts) Mob performs an action in another room.

echo echo(msg,about,opts) Echo a message to CH, or about CH (to room). $ variables available.

echoatechoat(ch,about,opts) Echo a message to a specific character. $ variables available.

echoaroundechoaround(ch,about,opts) Echo a message to all rooms adjacent to ch.

December 30, 2008, at 10:19 PM EST by admin
Changed lines 10-11 from:

ally alley(ch) Tests if ch is an ally of the current mob.

to:

ally ally(ch) Tests if ch is an ally of the current mob.

December 30, 2008, at 10:19 PM EST by admin
Changed lines 10-17 from:

ally Tests if ch is an ally of the current mob.

Calls another lua program. Argument list in details.

cancel Cancel a delay - mprog compability

canseechar Test if ch1 can see ch2.

to:

ally alley(ch) Tests if ch is an ally of the current mob.

call call(...) Calls another lua program. Argument list in details.

cancel cancel() Cancel a delay - mprog compability

canseechar canseechar(ch1,ch2) Test if ch1 can see ch2.

December 30, 2008, at 10:17 PM EST by admin
Changed lines 8-9 from:

affected Test if character has a specific affect flag set.

to:

affected affected(ch,flag) Test if character has a specific affect flag set.

December 30, 2008, at 10:13 PM EST by admin
Changed lines 6-7 from:

addstats Adds stats to an item

to:

addstats addstats(obj,stat,amount) Adds stats to an item

December 30, 2008, at 10:10 PM EST by admin
Changed lines 4-5 from:

adddelay Sets a timer to call a 'delay' trigger on the mob.

to:

adddelay addelay(seconds) Sets a timer to call a 'delay' trigger on the mob.

December 30, 2008, at 10:09 PM EST by admin
Changed lines 12-13 from:

Calls another lua program. Argument list in details.

to:

Calls another lua program. Argument list in details.

December 30, 2008, at 10:09 PM EST by admin
Added lines 1-129:

Click on the funtion to see an example if available.

adddelay Sets a timer to call a 'delay' trigger on the mob.

addstats Adds stats to an item

affected Test if character has a specific affect flag set.

ally Tests if ch is an ally of the current mob.

Calls another lua program. Argument list in details.

cancel Cancel a delay - mprog compability

canseechar Test if ch1 can see ch2.

carries Test if ch1 is carrying item in their inventory

cast Casts a spell at the target given, or self.

clantalk Allows clan mobs and guards to talk on their channel.

off) Test or set value of a channel flag on a player.

off) Test or set value of a configuration flag on a player.

countitems Counts how many of a specific item a player is wearing and/or carrying.

Inflict damage on CH. See details for argument list.

destroy Destroy one of more instances of item [objkey] on CH.

doat Mob performs an action in another room.

echo Echo a message to CH, or about CH (to room). $ variables available.

echoat Echo a message to a specific character. $ variables available.

echoaround Echo a message to all rooms adjacent to ch.

emote Emote a message to the room.

force Force a character, or group of characters, to perform an action.

forget Forget a previously remembered character - mprog compability

getmob Find a character in the game or a single room. Return as ch type.

obj|room,opts) Find an object. Return as obj type.

getroom Get room if roomkey exists, returned as room type variable.

give Give an item to character 'ch'

give Give experience to player 'ch'

giveqp Give quest points to player 'ch'

hasclass Tests whether CH has the given class.

hasdelay Tests whether the mob running the program has an old-style 'mob delay' set.

hasobj Tests if character has the item type carried. For compatibility with old mobprog conversions.

immune Tests if character is immune to a specific damage focus.

info Test or set value of an info channel setting.

off) Test or set value of an info channel setting.

isplayer Tests if ch is a player.

kill Attack another character.

mobflag Tests if mob has a flag set. Always false on a player.

mdo Causes the mob running the prog to execute a mud command.

mgoto Go to mob, if found.

mload Create an instance of mobkey and place it in the current room. Return mob created.

mobexists Tests if instances of mob exist, specific room or entire game.

movechar Transfer a character or group to another room from room progs.

1]) Test for, or set, flags on an item.

objingame Tests if instances of obj exist anywhere in game.

objhere Tests if instances of obj exist in current room.

oload Create an instance of an object in inventory or room. Return obj created.

peace Stops all combat on a given character, or on character running the prog.

pgoto Go to player, if found.

plrflag Tests if player has a specific flag set. Always false for mobs.

a mob to post a note from within lua progs.

purgemob Purge mob(s) in current room or in entire game.

purgeobj Purge various combinations of objects in room or game.

randchar Find a random charater in the current room. Return as ch type variable.

remember Remember 'ch' for use with delay triggers - mprog compability

rgoto Go to a specific room.

say Causes mob to say something to the room.

sayto Causes a "say" to be sent to single char and formatted for linebreaks. Used in Academy.

send Send a message to ch. Useful for debug and in progs where echo is not available.

social Causes the mob to execute a social.

summon Causes the character, if found, to be transferred to current room.

transfer Transfers character(s) already in the current room to another location.

wearsobj Tests if character has the item type worn. For compatibility with old mobprog conversions.

zecho Sends a message to all players in the current zone.