SlothMUD Wiki - User contributions [en]

Proc:Neighborhood

2021-09-18T19:37:18Z

Teker:

= Overview =

The neighborhood procedure allows players to build houses that attach to the current room. It also handles the outdoor portion of keyless entry if purchased in a house.

= KVP =

The neighborhood proc uses standard KVP to enable it. These KVP values are:

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Key !! Description
|-
| CFG_ID
| Standard proc key - must be set to 1.
|-
| PROC_NUM
| Standard proc key - must be set to 3.
|-
| PROC_ENABLED
| Standard proc key - must be set to 1.
|-
| RESERVE
| A colon separated list of direction names to reserve for future growth. This will prevent building houses in these directions. The list can contain full names (north:east:south) or abbreviations (w:u:d). If this value does not exist, players will be able to build in any direction where an existing room exit has not been defined.
|}

= Survey Command =

The survey command is enabled by the procedure and is used by players to find available locations for building houses. New houses can only be built in directions that do not currently have an exit. Exits can be reserved for future use by creating an exit in the desired direction to room -1.

= Build Command =

The build command is enabled by the procedure and allows players to build a house if they are carrying an appropriate hovel object. The command syntax is ''build <hovel object> <direction> <one or more door names>''. If the player has an appropriate hovel object and nothing exists in the direction specified, a new house will be created in that direction. If this is the player's first house, a key will be created and given to the player.

= Vault Keyless Entry =

The neighborhood proc caches the keyless entry phrases for neighboring house/vault rooms with keyless entry. These cached values can be seen via the command STATPROC ROOM even though they are not stored in KVP. When keyless entry is purchased or modified, the vault proc notifies the neighborhood to update its cache. Similarly, if a player enters a keyless entry phrase, the neighborhood proc checks the neighboring vault procs to make sure the player is on the permitted list of the appropriate vault. If so, the player is teleported inside.

[[Category:Building]]
[[Category:Room Procedures]]

Proc:Neighborhood

2021-09-18T19:36:23Z

Teker:

= Overview =

The neighborhood procedure allows players to build houses that attach to the current room. It also handles the outdoor portion of keyless entry if purchased in a house.

= KVP =

The neighborhood proc uses standard KVP to enable it. These KVP values are:

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Key !! Description
|-
| CFG_ID
| Standard proc key - must be set to 1.
|-
| PROC_NUM
| Standard proc key - must be set to 3.
|-
| PROC_ENABLED
| Standard proc key - must be set to 1.
|-
| RESERVE
| A colon separated list of direction names to reserve for future growth. This will prevent building houses in these directions. The list can contain full names (north, east, south) or abbreviations (w, u, d). If this value does not exist, players will be able to build in any direction where an existing room exit has not been defined.
|}

= Survey Command =

The survey command is enabled by the procedure and is used by players to find available locations for building houses. New houses can only be built in directions that do not currently have an exit. Exits can be reserved for future use by creating an exit in the desired direction to room -1.

= Build Command =

The build command is enabled by the procedure and allows players to build a house if they are carrying an appropriate hovel object. The command syntax is ''build <hovel object> <direction> <one or more door names>''. If the player has an appropriate hovel object and nothing exists in the direction specified, a new house will be created in that direction. If this is the player's first house, a key will be created and given to the player.

= Vault Keyless Entry =

The neighborhood proc caches the keyless entry phrases for neighboring house/vault rooms with keyless entry. These cached values can be seen via the command STATPROC ROOM even though they are not stored in KVP. When keyless entry is purchased or modified, the vault proc notifies the neighborhood to update its cache. Similarly, if a player enters a keyless entry phrase, the neighborhood proc checks the neighboring vault procs to make sure the player is on the permitted list of the appropriate vault. If so, the player is teleported inside.

[[Category:Building]]
[[Category:Room Procedures]]

MUDL:random npc on continent

2019-04-19T22:27:11Z

Teker:

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| random_npc_on_continent
|-
! Settable
| No
|-
! Returns
| NPC (character)
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Continent (integer)
|}

This function returns a random NPC located on the provided continent. See
[[MUDL:Continent Values|Continent Values]] for possible integer values.

= Example =
<pre>
TBD
</pre>

[[Category:Building]]
[[Category:MUDL|random_npc_on_continent]]

MUDL:random npc on continent

2019-04-19T22:26:54Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | random_npc_on_continent |- ! Settable | No |- ! Returns | NPC (ch..."

MUDL:Continent Values

2019-04-19T22:26:04Z

Teker: Created page with "The following values are used by MUDL when working with Continents: {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Integer ! String |- | 0 | Godsland..."

The following values are used by MUDL when working with Continents:

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Integer
! String
|-
| 0
| Godsland
|-
| 1
| Thordfalan
|-
| 2
| Thule
|-
| 3
| The Island
|-
| 4
| Niebelung
|-
| 5
| Lyme
|-
| 6
| The Clipper
|-
| 7
| Valkyre
|-
| 8
| The Ocean
|-
| 9
| On a Flight
|-
| 10
| Rhovanion
|-
| 11
| Atlantis
|-
| 12
| Euridyce
|}

[[Category:Building]]
[[Category:MUDL|Continent Values]]

MUDL:spell summon undead for levels

2019-04-19T22:17:16Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | spell_summon_undead_for_levels |- ! Settable | No |- ! Returns |..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| spell_summon_undead_for_levels
|-
! Settable
| No
|-
! Returns
| Summon undead creature (character)
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Caster (character), Total Levels of Summon Creature (integer),
Duration of Summon (integer)
|}

This function implements the summon undead spell for the caster. The mobile summoned will be the highest level mobile available given the total levels parameter. The summon will last for the duration provided. If the number of levels is less than the lowest summon mobile, the lowest summon mobile will be created. The mobile is created in the same room as the caster, charmed, and set to follow the caster. The return value is the new mobile.

= Example =
<pre>
TBD
</pre>

[[Category:Building]]
[[Category:MUDL|spell_summon_undead_for_levels]]

MUDL:spell animate dead for levels

2019-04-19T22:16:01Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | spell_animate_dead_for_levels |- ! Settable | No |- ! Returns | A..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| spell_animate_dead_for_levels
|-
! Settable
| No
|-
! Returns
| Animate dead creature (character)
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Caster (character), Total Levels of Summon Creature (integer),
Duration of Summon (integer)
|}

This function implements the animate dead spell for the caster. The mobile summoned will be the highest level mobile available given the total levels parameter. The summon will last for the duration provided. If the number of levels is less than the lowest animate mobile, the lowest animate mobile will be created. The mobile is created in the same room as the caster, charmed, and set to follow the caster. The return value is the new mobile.

= Example =
<pre>
TBD
</pre>

[[Category:Building]]
[[Category:MUDL|spell_animate_dead_for_levels]]

MUDL:sector is underwater

2019-04-19T22:09:26Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | sector_is_underwater |- ! Settable | No |- ! Returns | Boolean |}..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| sector_is_underwater
|-
! Settable
| No
|-
! Returns
| Boolean
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Room
|}

This function takes the input room and returns TRUE if the sector is underwater and requires water breathing and FALSE otherwise.

= Example =
<pre>
TBD
</pre>

[[Category:Building]]
[[Category:MUDL|sector_is_underwater]]

MUDL:sector is in air

2019-04-19T22:07:35Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | sector_is_in_air |- ! Settable | No |- ! Returns | Boolean |} {..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| sector_is_in_air
|-
! Settable
| No
|-
! Returns
| Boolean
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Room
|}

This function takes the input room and returns TRUE if the sector is in a room that requires flying and FALSE otherwise.

= Example =
<pre>
TBD
</pre>

[[Category:Building]]
[[Category:MUDL|sector_is_in_air]]

Proc:Vorpal Immunity

2019-04-19T19:35:09Z

Teker:

= Overview =

This procedure allows builders to add resistance to mobiles against chop/vorpal weapons.

Here is a list of keys that the procedure will use:

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Key !! Default !! Description
|-
| PROC_NUM
| 41
| Standard KVP key.
|-
| PROC_ENABLED
| 0 (false)
| Standard KVP key.
|-
| PERCENT_REDUCTION
| 0 (%)
| The percentage chance that the vorpal proc does nothing to this mobile.
|-
| PERCENT_DISARM
| 0 (%)
| The percentage chance that the vorpal proc will result in disarming the player.
|-
| DISARM_ROOM_MESSAGE
| $n skillfully blocks $N's swing and disarms $M!
| The message sent to the room when the mobile disarms the player.
|-
| DISARM_VICTIM_MESSAGE
| $n skillfully blocks your swing and disarms you!
| The message sent to the player being disarmed.
|-
| PERCENT_BREAK
| 0 (%)
| The percentage chance that the vorpal weapon will break during the attack. If this number is lower than the weapon's natural break percentage, the weapon's percentage is used instead.
|}

= Sample =

<pre>
addproc <mob> vorpal_immunity
setproc <mob> ## PERCENT_DISARM 50
setproc <mob> ## DISARM_ROOM_MESSAGE $n deftly disarms $N and tosses $p to the ground!
setproc <mob> ## DISARM_VICTIM_MESSAGE $n deftly disarms you and tosses $p to the ground!
setproc <mob> ## PROC_ENABLED 1
</pre>

[[Category:Building]]
[[Category:Mobile Procedures]]

MUDL:msg area

2019-03-17T22:51:53Z

Teker: /* Example */

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| msg_area
|-
! Settable
| No
|-
! Returns
| Boolean
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Area, Message (string)
|-
| Area, Message (string), Actor (character)
|-
| Area, Message (string), Actor (character), Item
|}

This function sends a message to all players in the specified area. If an actor and/or item are provided, dollar code substitution occurs ($n, $o, etc).

= Example =
<pre>
setproc <parent> # on_foo
foreach(mortal_in_area(%area), %9,
(
msg_area(%area, '$n is in the house!', %9)
)),

return(true)
@

setproc <parent> # PROC_ENABLED 1
</pre>

[[Category:Building]]
[[Category:MUDL|msg_area]]

Proc:Ambient Messages Random

2019-01-28T20:28:13Z

Teker: Replaced content with " There are two different procedures that use this name that slightly differ: * Proc:Ambient_Messages_Random_(area) * Proc:Ambient_Messages_Random_(room) Catego..."

There are two different procedures that use this name that slightly differ:
* [[Proc:Ambient_Messages_Random_(area)]]
* [[Proc:Ambient_Messages_Random_(room)]]

[[Category:Building]]

Proc:Ambient Messages Random (area)

2019-01-28T20:26:30Z

Teker:

= Overview =

The ambient_messages_random procedure allows builders to create custom messages that display on the game hour. These messages have no effect on game play and can be used to substitute for custom climate messages or just add to the flavor of a particular area. There is another slightly different procedure by the same name that can be added to rooms.

The builder defines a number of indoor and outdoor messages and each game hour a random roll is done (0 to MAX) and one of the messages is chosen to be displayed. The number of indoor and outdoor messages may be different. The "first" indoor message is defined in INDOOR_MSG_0 and the "first" outdoor message is defined in OUTDOOR_MSG_0.

Note that to turn off normal climate messages, you need to set the climate to none via "SETAREA <area #> CLIMATE NONE". Sky messages such as sunrise and sunset can be disabled via "SETAREA <area #> HIDE_SKY YES".

Here is a list of keys that the procedure will use:

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Key !! Default !! Description
|-
| INDOOR_MSG_0
| No message.
| The message that is displayed to players in the area that are indoors if the random roll results in 0. Additional messages would be defined in INDOOR_MSG_1, INDOOR_MSG_2, and so on.
|-
| OUTDOOR_MSG_0
| No message.
| The message that is displayed to players in the area that are outdoors if the random roll results in 0. Additional messages would be defined in OUTDOOR_MSG_1, OUTDOOR_MSG_2, and so on.
|}

= Sample =

This sample has 4 random strings (including one empty string).

<pre>
setproc area 1 OUTDOOR_MSG_0 Message 0
setproc area 1 OUTDOOR_MSG_1 Message 1
setproc area 1 OUTDOOR_MSG_3 Message 3
setproc area 1 PROC_ENABLED 1

</pre>

Note that the MAX value for outdoor messages is 3, so the random roll will be from 0 to 3. If 2 is rolled, there is no value, so nothing is displayed. There are no strings defined for indoor players, so they will never receive a message from this procedure.

[[Category:Building]]
[[Category:Area Procedures]]

Proc:Ambient Messages Random (room)

2019-01-28T20:25:50Z

Teker: Created page with " = Overview = The ambient_messages_random procedure allows builders to create custom messages that display on the game hour. These messages have no effect on game play and c..."

= Overview =

The ambient_messages_random procedure allows builders to create custom messages that display on the game hour. These messages have no effect on game play and can be used to substitute for custom climate messages or just add to the flavor of a particular room. There is another slightly different procedure by the same name that can be added to areas.

The builder defines a number of asleep and awake messages and each game hour a random roll is done (0 to MAX) and one of the messages is chosen to be displayed. The number of asleep and awake messages may be different. The "first" asleep message is defined in ASLEEP_MSG_0 and the "first" awake message is defined in AWAKE_MSG_0.

Note that to turn off normal climate messages, you need to set the climate to none via "SETAREA <area #> CLIMATE NONE". Sky messages such as sunrise and sunset can be disabled via "SETAREA <area #> HIDE_SKY YES".

Here is a list of keys that the procedure will use:

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Key !! Default !! Description
|-
| ASLEEP_MSG_0
| No message.
| The message that is displayed to players in the area that are asleep if the random roll results in 0. Additional messages would be defined in ASLEEP_MSG_1, ASLEEP_MSG_2, and so on.
|-
| AWAKE_MSG_0
| No message.
| The message that is displayed to players in the area that are awake if the random roll results in 0. Additional messages would be defined in AWAKE_MSG_1, AWAKE_MSG_2, and so on.
|}

= Sample =

This sample has 4 random strings (including one empty string).

<pre>
setproc area 1 AWAKE_MSG_0 Message 0
setproc area 1 AWAKE_MSG_1 Message 1
setproc area 1 AWAKE_MSG_3 Message 3
setproc area 1 PROC_ENABLED 1

</pre>

Note that the MAX value for awake messages is 3, so the random roll will be from 0 to 3. If 2 is rolled, there is no value, so nothing is displayed. There are no strings defined for asleep players, so they will never receive a message from this procedure.

[[Category:Building]]
[[Category:Room Procedures]]

Category:Area Procedures

2019-01-28T20:22:45Z

Teker:

The following procedures can be added to areas using ADDPROC AREA <procedure name>.

[[Category:Building]]

Proc:Ambient Messages Random (area)

2019-01-28T20:22:20Z

= Overview =

The ambient_messages_random procedure allows builders to create custom messages that display on the game hour. These messages have no effect on game play and can be used to substitute for custom climate messages or just add to the flavor of a particular area. This procedure can only be added to areas.

The builder defines a number of indoor and outdoor messages and each game hour a random roll is done (0 to MAX) and one of the messages is chosen to be displayed. The number of indoor and outdoor messages may be different. The "first" indoor message is defined in INDOOR_MSG_0 and the "first" outdoor message is defined in OUTDOOR_MSG_0.

Note that to turn off normal climate messages, you need to set the climate to none via "SETAREA <area #> CLIMATE NONE". Sky messages such as sunrise and sunset can be disabled via "SETAREA <area #> HIDE_SKY YES".

Here is a list of keys that the procedure will use:

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Key !! Default !! Description
|-
| INDOOR_MSG_0
| No message.
| The message that is displayed to players in the area that are indoors if the random roll results in 0. Additional messages would be defined in INDOOR_MSG_1, INDOOR_MSG_2, and so on.
|-
| OUTDOOR_MSG_0
| No message.
| The message that is displayed to players in the area that are outdoors if the random roll results in 0. Additional messages would be defined in OUTDOOR_MSG_1, OUTDOOR_MSG_2, and so on.
|}

= Sample =

This sample has 4 random strings (including one empty string).

<pre>
setproc area 1 OUTDOOR_MSG_0 Message 0
setproc area 1 OUTDOOR_MSG_1 Message 1
setproc area 1 OUTDOOR_MSG_3 Message 3
setproc area 1 PROC_ENABLED 1

</pre>

Note that the MAX value for outdoor messages is 3, so the random roll will be from 0 to 3. If 2 is rolled, there is no value, so nothing is displayed. There are no strings defined for indoor players, so they will never receive a message from this procedure.

[[Category:Building]]
[[Category:Area Procedures]]

Proc:Special Attack

2019-01-08T16:26:22Z

Teker: /* Overview */

= Overview =

This procedure allows builders to add poison type effects to weapons.

Here is a list of keys that the procedure will use:

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Key !! Default !! Description
|-
| CFG_ID
| 1
| Standard KVP value.
|-
| PROC_NUM
| 13
| Standard KVP value.
|-
| PROC_ENABLED
| 0 (false)
| Standard KVP value.
|-
| ATTACK_##_DAMAGE_CHANCE
| 0 (%)
| The percentage chance that a particular attack type will trigger extra damage. The ## corresponds with the skill number of the attack being performed. A list of skill numbers can be found TBD.
|-
| ATTACK_##_DAMAGE_DICE
| 1
| Number of dice to roll for the damage effect.
|-
| ATTACK_##_DAMAGE_DIE_SIZE
| 1
| Size of the dice to roll for the damage effect.
|-
| ATTACK_##_DAMAGE_ADDITIONAL
| 0
| Additional points to add to the damage effect.
|-
| ATTACK_##_DAMAGE_FLAGS
| 0
| See the [[MUDL:damage|MUDL damage]] function for appropriate values.
|-
| ATTACK_##_DAMAGE_MESSAGE_ACTOR
| You drive $p to the hilt in $N and $E shudders from the poison.
| Message shown to the actor (attacker) when the damage effect fires.
|-
| ATTACK_##_DAMAGE_MESSAGE_ROOM
| $n thrusts $p deep into $N and injects a poison.
| Message shown to the room when the damage effect fires.
|-
| ATTACK_##_DAMAGE_MESSAGE_VICTIM
| $n thrusts $p deep into your body, you feel a burning pain!
| Message shown to the victim when the damage effect fires.
|-
| ATTACK_##_ETHER_MESSAGE_ACTOR
| Your weapon passes deeply into $N but seems to have no effect.
| Message shown to the actor (attacker) when the damage is negated due to the victim being ethereal.
|-
| ATTACK_##_ETHER_MESSAGE_ROOM
| $n thrusts $p deep into $N without effect.
| Message shown to the room when the damage is negated due to the victim being ethereal.
|-
| ATTACK_##_ETHER_MESSAGE_VICTIM
| $n thrusts $s weapon deep into you but it has no effect.
| Message shown to the victim when the damage is negated due to the victim being ethereal.
|-
| ATTACK_##_VICTIM_CHANCE
| 0 (%)
| The percentage chance that the attack will trigger a special effect targeting the victim.
|-
| ATTACK_##_VICTIM_EFFECT
|
| A colon (:) separated set of values representing the special effect. See table below for format.
|-
| ATTACK_##_VICTIM_FLAGS
| 0
| See the [[MUDL:damage|MUDL damage]] function for appropriate values.
|-
| ATTACK_##_VICTIM_MESSAGE_ACTOR
| The poison on $p turns $N's flesh black.
| Message shown to the actor (attacker) when the special effect fires.
|-
| ATTACK_##_VICTIM_MESSAGE_ROOM
| The poison on $n's $p turns $N's flesh black.
| Message shown to the room when the special effect fires.
|-
| ATTACK_##_VICTIM_MESSAGE_VICTIM
| The poison on $n's $p turns your flesh black.
| Message shown to the victim when the special effect fires.
|-
| ATTACK_##_ACTOR_CHANCE
| 0 (%)
| The percentage chance that the attack will trigger a special effect targeting the actor/attacker.
|-
| ATTACK_##_ACTOR_EFFECT
|
| A colon (:) separated set of values representing the special effect. See table below for formatting.
|-
| ATTACK_##_ACTOR_FLAGS
| 0
| See the [[MUDL:damage|MUDL damage]] function for appropriate values.
|-
| ATTACK_##_ACTOR_MESSAGE_ACTOR
| The poison on $p turns $N's flesh black.
| Message shown to the actor (attacker) when the special effect fires.
|-
| ATTACK_##_ACTOR_MESSAGE_ROOM
| The poison on $n's $p turns $N's flesh black.
| Message shown to the room when the special effect fires.
|-
| ATTACK_##_ACTOR_MESSAGE_VICTIM
| The poison on $n's $p turns your flesh black.
| Message shown to the victim when the special effect fires.
|}

The ATTACK_##_VICTIM_EFFECT AND ATTACK_##_ACTOR_EFFECT keys consist of 7 numbers separated by colons. These describe the special effect that the weapon generates. The values are:

Here is a list of keys that the procedure will use:

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Index !! Description
|-
| 1 || Spell Id
|-
| 2 || Level type that follows in value 3. 
0 = Use the value in element #3 for the level. 
1 = Use the player's prime class for the level. Element #3 is ignored but must be specificed (use 0). 
2 = Use the player's level in the class specified in element #3 to determine the level. A list of PC class values can be found in [[MUDL:PC_Class_Values]]. 
|-
| 4 || APPLY_TYPE.
|-
| 5 || APPLY amount.
|-
| 6 || Duration in minutes.
|-
| 7 || Apply bitvector.
|}

= Sample =

<pre>
TBD
</pre>

[[Category:Building]]
[[Category:Item Procedures]]

Proc:Special Attack

2019-01-08T16:25:34Z

Teker:

= Overview =

This procedure allows builders to add poison type effects to weapons.

Here is a list of keys that the procedure will use:

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Key !! Default !! Description
|-
| CFG_ID
| 1
| Standard KVP value.
|-
| PROC_NUM
| 13
| Standard KVP value.
|-
| PROC_ENABLED
| 0 (false)
| Standard KVP value.
|-
| ATTACK_##_DAMAGE_CHANCE
| 0 (%)
| The percentage chance that a particular attack type will trigger extra damage. The ## corresponds with the skill number of the attack being performed. A list of skill numbers can be found TBD. Also, the word OTHER can be specified instead of a number which would provide a damage effect for attacks that do not match any ATTACK_## KVPs.
|-
| ATTACK_##_DAMAGE_DICE
| 1
| Number of dice to roll for the damage effect.
|-
| ATTACK_##_DAMAGE_DIE_SIZE
| 1
| Size of the dice to roll for the damage effect.
|-
| ATTACK_##_DAMAGE_ADDITIONAL
| 0
| Additional points to add to the damage effect.
|-
| ATTACK_##_DAMAGE_FLAGS
| 0
| See the [[MUDL:damage|MUDL damage]] function for appropriate values.
|-
| ATTACK_##_DAMAGE_MESSAGE_ACTOR
| You drive $p to the hilt in $N and $E shudders from the poison.
| Message shown to the actor (attacker) when the damage effect fires.
|-
| ATTACK_##_DAMAGE_MESSAGE_ROOM
| $n thrusts $p deep into $N and injects a poison.
| Message shown to the room when the damage effect fires.
|-
| ATTACK_##_DAMAGE_MESSAGE_VICTIM
| $n thrusts $p deep into your body, you feel a burning pain!
| Message shown to the victim when the damage effect fires.
|-
| ATTACK_##_ETHER_MESSAGE_ACTOR
| Your weapon passes deeply into $N but seems to have no effect.
| Message shown to the actor (attacker) when the damage is negated due to the victim being ethereal.
|-
| ATTACK_##_ETHER_MESSAGE_ROOM
| $n thrusts $p deep into $N without effect.
| Message shown to the room when the damage is negated due to the victim being ethereal.
|-
| ATTACK_##_ETHER_MESSAGE_VICTIM
| $n thrusts $s weapon deep into you but it has no effect.
| Message shown to the victim when the damage is negated due to the victim being ethereal.
|-
| ATTACK_##_VICTIM_CHANCE
| 0 (%)
| The percentage chance that the attack will trigger a special effect targeting the victim.
|-
| ATTACK_##_VICTIM_EFFECT
|
| A colon (:) separated set of values representing the special effect. See table below for format.
|-
| ATTACK_##_VICTIM_FLAGS
| 0
| See the [[MUDL:damage|MUDL damage]] function for appropriate values.
|-
| ATTACK_##_VICTIM_MESSAGE_ACTOR
| The poison on $p turns $N's flesh black.
| Message shown to the actor (attacker) when the special effect fires.
|-
| ATTACK_##_VICTIM_MESSAGE_ROOM
| The poison on $n's $p turns $N's flesh black.
| Message shown to the room when the special effect fires.
|-
| ATTACK_##_VICTIM_MESSAGE_VICTIM
| The poison on $n's $p turns your flesh black.
| Message shown to the victim when the special effect fires.
|-
| ATTACK_##_ACTOR_CHANCE
| 0 (%)
| The percentage chance that the attack will trigger a special effect targeting the actor/attacker.
|-
| ATTACK_##_ACTOR_EFFECT
|
| A colon (:) separated set of values representing the special effect. See table below for formatting.
|-
| ATTACK_##_ACTOR_FLAGS
| 0
| See the [[MUDL:damage|MUDL damage]] function for appropriate values.
|-
| ATTACK_##_ACTOR_MESSAGE_ACTOR
| The poison on $p turns $N's flesh black.
| Message shown to the actor (attacker) when the special effect fires.
|-
| ATTACK_##_ACTOR_MESSAGE_ROOM
| The poison on $n's $p turns $N's flesh black.
| Message shown to the room when the special effect fires.
|-
| ATTACK_##_ACTOR_MESSAGE_VICTIM
| The poison on $n's $p turns your flesh black.
| Message shown to the victim when the special effect fires.
|}

The ATTACK_##_VICTIM_EFFECT AND ATTACK_##_ACTOR_EFFECT keys consist of 7 numbers separated by colons. These describe the special effect that the weapon generates. The values are:

Here is a list of keys that the procedure will use:

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Index !! Description
|-
| 1 || Spell Id
|-
| 2 || Level type that follows in value 3. 
0 = Use the value in element #3 for the level. 
1 = Use the player's prime class for the level. Element #3 is ignored but must be specificed (use 0). 
2 = Use the player's level in the class specified in element #3 to determine the level. A list of PC class values can be found in [[MUDL:PC_Class_Values]]. 
|-
| 4 || APPLY_TYPE.
|-
| 5 || APPLY amount.
|-
| 6 || Duration in minutes.
|-
| 7 || Apply bitvector.
|}

= Sample =

<pre>
TBD
</pre>

[[Category:Building]]
[[Category:Item Procedures]]

Proc:Special Attack

2019-01-08T00:21:39Z

Teker:

= Overview =

This procedure allows builders to add poison type effects to weapons.

Here is a list of keys that the procedure will use:

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Key !! Default !! Description
|-
| CFG_ID
| 1
| Standard KVP value.
|-
| PROC_NUM
| 13
| Standard KVP value.
|-
| PROC_ENABLED
| 0 (false)
| Standard KVP value.
|-
| ATTACK_##_DAMAGE_CHANCE
| 0 (%)
| The percentage chance that a particular attack type will trigger extra damage. The ## corresponds with the skill number of the attack being performed. A list of skill numbers can be found TBD. Also, the word OTHER can be specified instead of a number which would provide a damage effect for attacks that do not match any ATTACK_## KVPs.
|-
| ATTACK_##_DAMAGE_DICE
| 1
| Number of dice to roll for the damage effect.
|-
| ATTACK_##_DAMAGE_DIE_SIZE
| 1
| Size of the dice to roll for the damage effect.
|-
| ATTACK_##_DAMAGE_ADDITIONAL
| 0
| Additional points to add to the damage effect.
|-
| ATTACK_##_DAMAGE_FLAGS
| 0
| See the [[MUDL:damage|MUDL damage]] function for appropriate values.
|-
| ATTACK_##_DAMAGE_MESSAGE_ACTOR
| You drive $p to the hilt in $N and $E shudders from the poison.
| Message shown to the actor (attacker) when the damage effect fires.
|-
| ATTACK_##_DAMAGE_MESSAGE_ROOM
| $n thrusts $p deep into $N and injects a poison.
| Message shown to the room when the damage effect fires.
|-
| ATTACK_##_DAMAGE_MESSAGE_VICTIM
| $n thrusts $p deep into your body, you feel a burning pain!
| Message shown to the victim when the damage effect fires.
|-
| ATTACK_##_ETHER_MESSAGE_ACTOR
| Your weapon passes deeply into $N but seems to have no effect.
| Message shown to the actor (attacker) when the damage is negated due to the victim being ethereal.
|-
| ATTACK_##_ETHER_MESSAGE_ROOM
| $n thrusts $p deep into $N without effect.
| Message shown to the room when the damage is negated due to the victim being ethereal.
|-
| ATTACK_##_ETHER_MESSAGE_VICTIM
| $n thrusts $s weapon deep into you but it has no effect.
| Message shown to the victim when the damage is negated due to the victim being ethereal.
|-
| ATTACK_##_VICTIM_CHANCE
| 0 (%)
| The percentage chance that the attack will trigger a special effect targeting the victim.
|-
| ATTACK_##_VICTIM_EFFECT
|
| A colon (:) separated set of values representing the special effect. See table below for format.
|-
| ATTACK_##_VICTIM_FLAGS
| 0
| See the [[MUDL:damage|MUDL damage]] function for appropriate values.
|-
| ATTACK_##_VICTIM_MESSAGE_ACTOR
| The poison on $p turns $N's flesh black.
| Message shown to the actor (attacker) when the special effect fires.
|-
| ATTACK_##_VICTIM_MESSAGE_ROOM
| The poison on $n's $p turns $N's flesh black.
| Message shown to the room when the special effect fires.
|-
| ATTACK_##_VICTIM_MESSAGE_VICTIM
| The poison on $n's $p turns your flesh black.
| Message shown to the victim when the special effect fires.
|-
| ATTACK_##_ACTOR_CHANCE
| 0 (%)
| The percentage chance that the attack will trigger a special effect targeting the actor/attacker.
|-
| ATTACK_##_ACTOR_EFFECT
|
| A colon (:) separated set of values representing the special effect. See table below for formatting.
|-
| ATTACK_##_ACTOR_FLAGS
| 0
| See the [[MUDL:damage|MUDL damage]] function for appropriate values.
|-
| ATTACK_##_ACTOR_MESSAGE_ACTOR
| The poison on $p turns $N's flesh black.
| Message shown to the actor (attacker) when the special effect fires.
|-
| ATTACK_##_ACTOR_MESSAGE_ROOM
| The poison on $n's $p turns $N's flesh black.
| Message shown to the room when the special effect fires.
|-
| ATTACK_##_ACTOR_MESSAGE_VICTIM
| The poison on $n's $p turns your flesh black.
| Message shown to the victim when the special effect fires.
|}

The ATTACK_##_VICTIM_EFFECT AND ATTACK_##_ACTOR_EFFECT keys consist of 7 numbers separated by colons. These describe the special effect that the weapon generates. The values are:

Here is a list of keys that the procedure will use:

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Index !! Description
|-
| 1 || Spell Id
|-
| 2 || Level type that follows in value 3. 
0 = 
1 = 
2 = 
|-
| 4 || APPLY_TYPE.
|-
| 5 || APPLY amount.
|-
| 6 || Duration in minutes.
|-
| 7 || Apply bitvector.
|}

= Sample =

<pre>
TBD
</pre>

[[Category:Building]]
[[Category:Item Procedures]]

Proc:Special Attack

2019-01-07T23:31:08Z

Teker: Teker moved page Proc:Poison Weapon to Proc:Special Attack

Proc:Poison Weapon

2019-01-07T23:31:08Z

Teker: Teker moved page Proc:Poison Weapon to Proc:Special Attack

#REDIRECT [[Proc:Special Attack]]

Proc:Special Attack

2019-01-05T18:31:12Z

Teker:

Guide:Damage Spells

2019-01-03T22:10:49Z

Teker:

{{Template:GuideWelcome}}

{{Template:NewPlayerGuideHeader}}

= Introduction =

There are a large number of damage-based spells in SlothMUD that are available to the different classes and work under various circumstances. This guide ranks the various damage spells by average damage to give players a better idea as to which spells they should use at different levels.

= Level 10 Spells =

{| border="1"
! Rank
! Spell
! Level
! Notes
|-
| 1 || [[Spell:Dispel Evil|Dispel Evil]]
| Cl 10 || Only works on evil targets
|-
|   || [[Spell:Dispel Good|Dispel Good]]
| Ne 9 || Only works on good targets
|-
| 2 || [[Spell:Lightning Bolt|Lightning Bolt]]
| Ma 9, Ba 17 ||  
|-
| 3 || [[Spell:Turn Undead|Turn Undead]]
| Cl 1 || Only works on undead creatures
|-
| 4 || [[Spell:Shocking Grasp|Shocking Grasp]]
| Ma 7 ||  
|-
| 5 || [[Spell:Putrefy|Putrefy]]
| Ne 9 || Only works on wounded targets
|-
| 6 || [[Spell:Cure Normal|Cure Normal]]
| Cl 10, Dr 14, Ma 36
| Only works on targets that are damaged by heal spells
|}

= Level 20 Spells =

{| border="1"
! Rank
! Spell
! Level
! Notes
|-
| 1 || [[Spell:Ice Ray|Ice Ray]]
| Ma 20 ||  
|-
| 2 || [[Spell:Fireball|Fireball]]
| Ma 15, Ba 23 ||  
|-
| 3 || [[Spell:Call Lightning|Call Lightning]]
| Cl 12, Dr 15 || Only works outdoors and under certain weather conditions
|-
| 4 || [[Spell:Dispel Evil|Dispel Evil]]
| Cl 10 || Only works on evil targets
|-
|   || [[Spell:Dispel Good|Dispel Good]]
| Ne 9 || Only works on good targets
|-
| 5 || [[Spell:Turn Undead|Turn Undead]]
| Cl 1 || Only works on undead creatures
|-
| 6 || [[Spell:Flame Strike|Flame Strike]]
| Cl 14 ||  
|-
| 7 || [[Spell:Colour Spray|Colour Spray]]
| Ma 11, Ba 19 ||  
|}

= Level 30 Spells =

{| border="1"
! Rank
! Spell
! Level
! Notes
|-
| 1 || [[Spell:Disintegrate|Disintegrate]]
| Ma 28 ||  
|-
| 2 || [[Spell:Greater Heal|Greater Heal]]
| Cl 30 || Only works on targets that are damaged by heal spells
|-
| 3 || [[Spell:Call Lightning|Call Lightning]]
| Cl 12, Dr 15 || Only works outdoors and under certain weather conditions
|-
| 4 || [[Spell:Turn Undead|Turn Undead]]
| Cl 1 || Only works on undead creatures
|-
| 5 || [[Spell:Acid Blast|Acid Blast]]
| Ma 25 ||  
|-
|   || [[Spell:Ice Ray|Ice Ray]]
| Ma 20 ||  
|-
| 6 || [[Spell:Twister|Twister]]
| Dr 30 ||  
|-
|   || [[Spell:Word of Pain|Word of Pain]]
| Ne 25 ||  
|-
| 7 || [[Song:Flames at Midnight|Flames at Midnight]]
| Ba 28 ||  
|-
| 8 || [[Spell:Dispel Evil|Dispel Evil]]
| Cl 10 || Only works on evil targets
|-
|   || [[Spell:Dispel Good|Dispel Good]]
| Ne 9 || Only works on good targets
|-
|   || [[Spell:Sunbeam|Sunbeam]]
| Dr 25 ||  
|-
| 9 || [[Spell:Heal|Heal]]
| Cl 25, Dr 30 || Only works on targets that are damaged by heal spells
|-
| 10 || [[Spell:Fireball|Fireball]]
| Ma 15, Ba 23 ||  
|-
| 11 || [[Spell:Flame Strike|Flame Strike]]
| Ma 15, Ba 23 ||  
|-
|   || [[Spell:Hellstrike|Hellstrike]]
| Cl 27, Ne 27 ||  
|}

= Level 40 Spells =

{| border="1"
! Rank
! Spell
! Level
! Notes
|-
| 1 || [[Spell:Dawnfire|Dawnfire]]
| Dr 35 || Only works outdoors at specific times of day
|-
| 2 || [[Spell:Frostbolt|Frostbolt]]
| Ma 38 ||  
|-
| 3 || [[Spell:Firewind|Firewind]]
| Ma 36 ||  
|-
| 4 || [[Spell:Thunder Clap|Thunder Clap]]
| Ma 34 ||  
|-
| 5 || [[Spell:Corrosive Surge|Corrosive Surge]]
| Ma 32 ||  
|-
| 6 || [[Spell:Restoration|Restoration]]
| Cl 35 || Only works on targets that are damaged by heal spells
|-
| 7 || [[Song:Cry of the Avatars|Cry of the Avatars]]
| Ba 36 ||  
|-
| 8 || [[Spell:Call Lightning|Call Lightning]]
| Cl 12, Dr 15 || Only works outdoors and under certain weather conditions
|-
|   || [[Spell:Disintegrate|Disintegrate]]
| Ma 28 ||  
|-
| 9 || [[Spell:Turn Undead|Turn Undead]]
| Cl 1 || Only works on undead creatures
|-
| 10 || [[Spell:Demon Touch|Demon Touch]]
| Ma 34 ||  
|-
| 11 || [[Spell:Greater_Heal|Greater Heal]]
| Cl 30 || Only works on targets that are damaged by heal spells
|-
| 12 || [[Spell:Destruction|Destruction]]
| Ne 36 ||  
|}

{{Template:NewPlayerGuideFooter}}

[[Category: Guides|Damage Spells]]
[[Category: New Player Guides|Damage Spells]]

Proc:Special Attack

2019-01-03T20:50:20Z

Teker:

Proc:Special Attack

2019-01-03T20:49:45Z

Teker:

Proc:Special Attack

2019-01-03T20:01:51Z

Teker:

Proc:Special Attack

2019-01-03T19:36:33Z

Teker: Created page with " = Overview = This procedure allows builders to add poison type effects to weapons. Here is a list of keys that the procedure will use: {|class="abilitiestable" border="0"..."

Proc:Shadow kill

2018-12-18T23:07:33Z

Teker:

= Overview =

Mobiles with this procedure will look for players to hunt down and kill.

= KVP =

This procedure using the following KVP:

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Key !! Default !! Description
|-
| CFG_ID
|  
| Standard proc key - must be set to 1.
|-
| PROC_NUM
|  
| Standard proc key - must be set to 6.
|-
| PROC_ENABLED
| 0 (FALSE)
| Standard proc key - must be set to 1.
|-
| PROC_DEBUG
| 0 (FALSE)
| Standard proc key. By default this key does not exist but it can be set to 1 to print out a series of debug messages to the room with the mobile.
|-
| SHADOW_CHANCE
| 0
| A number indicating the chance the mobile will start to hunt a new target. The final chance of this happening is SHADOW_CHANCE / CHANCE_SIDES.
|-
| CHANCE_SIDES
| 100
| A number indicating the size of die to roll when determining the chance of hunting a new target.
|-
| TARGET_AREA
| AREA
| Whether the mobile targets players in the AREA, CONTINENT, or WORLD.
|-
| TARGET_POSITION_MASK
| 1022 (all non-dead positions)
| A bitmask containing the list of player positions that are allowed for targets. For individual position values, see the [[Character Position Table]].
|-
| TARGET_FILTER
| No filter
| The name and parameters to a custom filter function. For more specific values, see the [[Target Filter Function List]].
|-
| TRANSPORT
| HUNT
| The method the mobile will use to reach the target. This can be HUNT, SHADOWWALK, GATE, or TELEPORT.
|-
| TELEPORT_STRING_ROOM
| $n slowly fades in to existence.
| If TRANSPORT is set to TELEPORT, this message is displayed to the room when the mobile teleports to the target. If you don't want to display anything, set this to an empty value.
|-
| ATTACK_STRING_CHAR
| $n leaps out of the shadows and attacks you!
| Message displayed to the target when the mobile starts the attack.
|-
| ATTACK_STRING_ROOM
| $n leaps out of the shadows and attacks $N!
| Message displayed to the room when the mobile starts the attack.
|-
| TARGET
| No target
| A temporary value containing the name of the player the the mobile is currently targeting.
|}

= Obsolete KVP =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Key !! Default !! Description
|-
| USE_HUNT
| 1 (True)
| This value is still processed if the TRANSPORT value is missing. A value of 0 translates to SHADOWWALK and all other values translate to HUNT.
|-
| STRING_CHAR
| n/a
| Changed to ATTACK_STRING_CHAR for clarity. STRING_CHAR is now ignored.
|-
| STRING_ROOM
| n/a
| Changed to ATTACK_STRING_ROOM for clarity. STRING_ROOM is now ignored.
|}

[[Category:Building]]
[[Category:Mobile Procedures]]

Target Filter Function List

2018-12-17T16:57:08Z

Teker: Created page with " = Overview = Some special procedures target random players in the world for their effects. In order to streamline this selection, the following player filter functions have..."

= Overview =

Some special procedures target random players in the world for their effects. In order to streamline this selection, the following player filter functions have been written.

= Values =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Name !! Parameters !! Description
|-
| LEADER
| None
| Target only group leaders or solo players.
|}

= KVP Values =

When putting a filter function into KVP, it should be formatted as <Function Name>:<Argument 1>:<Argument 2> ...

[[Category:Building]]

Character Position Table

2018-12-17T16:35:23Z

Teker: Created page with " = Overview = The game stores the character's position (standing, fighting, etc) as an integer. = Values = {|class="abilitiestable" border="0" cellspacing="0" cellpadding=..."

= Overview =

The game stores the character's position (standing, fighting, etc) as an integer.

= Values =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Position !! Value !! Bitmask Value
|-
| Dead
| 0
| 1
|-
| Mortally Wounded
| 1
| 2
|-
| Incapacitated
| 2
| 4
|-
| Stunned
| 3
| 8
|-
| Sleeping
| 4
| 16
|-
| Resting
| 5
| 32
|-
| Sitting
| 6
| 64
|-
| Crawling (not used)
| 7
| 128
|-
| Fighting
| 8
| 256
|-
| Standing
| 9
| 512
|}

= Combined Bitmask Values =

The bitmask values can be combined to form a mask that can contain multiple positions. Common values are:
* 1023 = Any position
* 1022 = Not dead
* 1016 = Not dying or dead
* 992 = Awake

[[Category:Building]]

Proc:Shadow kill

2018-12-17T16:27:28Z

Teker: Created page with " = Overview = Mobiles with this procedure will look for players to hunt down and kill. = KVP = This procedure using the following KVP: {|class="abilitiestable" border="0"..."

= Overview =

Mobiles with this procedure will look for players to hunt down and kill.

= KVP =

This procedure using the following KVP:

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Key !! Default !! Description
|-
| CFG_ID
|  
| Standard proc key - must be set to 1.
|-
| PROC_NUM
|  
| Standard proc key - must be set to 6.
|-
| PROC_ENABLED
| 0 (FALSE)
| Standard proc key - must be set to 1.
|-
| PROC_DEBUG
| 0 (FALSE)
| Standard proc key. By default this key does not exist but it can be set to 1 to print out a series of debug messages to the room with the mobile.
|-
| SHADOW_CHANCE
| 0
| A number indicating the chance the mobile will start to hunt a new target. The final chance of this happening is SHADOW_CHANCE / CHANCE_SIDES.
|-
| CHANCE_SIDES
| 100
| A number indicating the size of die to roll when determining the chance of hunting a new target.
|-
| TARGET_AREA
| AREA
| Whether the mobile targets players in the AREA, CONTINENT, or WORLD.
|-
| TARGET_POSITION_MASK
| 1022 (all non-dead positions)
| A bitmask containing the list of player positions that are allowed for targets. For individual position values, see the [[Character Position Table]].
|-
| TARGET_FILTER
| No filter
| The name and parameters to a custom filter function. For more specific values, see the [[Target Filter Function List]].
|-
| TRANSPORT
| HUNT
| The method the mobile will use to reach the target. This can be HUNT, SHADOWWALK, GATE, or TELEPORT.
|-
| TELEPORT_STRING_ROOM
| $n slowly fades in to existence.
| If TRANSPORT is set to TELEPORT, this message is displayed to the room when the mobile teleports to the target. If you don't want to display anything, set this to an empty value.
|-
| ATTACK_STRING_CHAR
| $n leaps out of the shadows and attacks you!
| Message displayed to the target when the mobile starts the attack.
|-
| ATTACK_STRING_ROOM
| $n leaps out of the shadows and attacks $N!
| Message displayed to the room when the mobile starts the attack.
|-
| TARGET
| No target
| A temporary value containing the name of the player the the mobile is currently targeting.
|}

[[Category:Building]]
[[Category:Mobile Procedures]]

MUDL:array reverse

2018-12-02T04:45:38Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | array_reverse |- ! Settable | No |- ! Returns | Array |} {|clas..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| array_reverse
|-
! Settable
| No
|-
! Returns
| Array
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Array (of any type)
|}

This function takes the input array and returns a new array with the previous elements in reverse.

= Example =
<pre>
setproc <parent> # on_foo
foreach(array_reverse(range(1, 10)), %9,
(
msg_room(%room, '' + %9)
)),

return(true)
</pre>

[[Category:Building]]
[[Category:MUDL|array_reverse]]

Proc:Vorpal Immunity

2018-11-24T22:33:11Z

Teker: Teker moved page Proc::Vorpal Immunity to Proc:Vorpal Immunity

Proc::Vorpal Immunity

2018-11-24T22:33:11Z

Teker: Teker moved page Proc::Vorpal Immunity to Proc:Vorpal Immunity

#REDIRECT [[Proc:Vorpal Immunity]]

MUDL:is container

2018-11-24T15:50:04Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | is_container |- ! Settable | No |- ! Returns | Boolean |} {|cla..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| is_container
|-
! Settable
| No
|-
! Returns
| Boolean
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Item
|}

This function returns True if the specified item is a container. In builder terms, that means the item's type is set to Container or Keychain.

= Example =
<pre>
TBD
</pre>

[[Category:Building]]
[[Category:MUDL|is_container]]

MUDL:is locked

2018-11-24T15:48:23Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | is_locked |- ! Settable | No |- ! Returns | Boolean |} {|class=..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| is_locked
|-
! Settable
| No
|-
! Returns
| Boolean
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Direction (string)
|-
| Room, Direction (string)
|-
| Item
|}

In the first two cases, this function returns whether the exit in the given direction from the given room is locked. This means that it must first be a passable sort of exit and it must be set up as a door and locked. The second argument is the direction, as one of the strings 'north', 'south', 'east', 'west', 'up', or 'down'. While this function is not settable, the locked status of a door can be set with the flag function.

In the third case, this function returns True if the specified item is a container and the container is currently locked.

= Example =
<pre>
TBD
</pre>

[[Category:Building]]
[[Category:MUDL|is_locked]]

MUDL:is open

2018-11-24T15:45:45Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | is_open |- ! Settable | No |- ! Returns | Boolean |} {|class="a..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| is_open
|-
! Settable
| No
|-
! Returns
| Boolean
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Direction (string)
|-
| Room, Direction (string)
|-
| Item
|}

In the first two cases, this function returns whether the exit in the given direction from the given room is open. This means that it must first be a passable sort of exit, and second it must not currently be impeded by, for example, a closed door. The second argument is the direction, as one of the strings 'north', 'south', 'east', 'west', 'up', or 'down'. While this function is not settable, the open status of a door can be set with the flag function.

In the third case, this function returns True if the specified item is a container and the container is currently open.

= Example =
<pre>
TBD
</pre>

[[Category:Building]]
[[Category:MUDL|is_open]]

MUDL:Construct

2018-11-19T23:53:06Z

Teker: /* Command Syntax */

__TOC__

= Overview =

This MUDL function gets called when:
* The room containing the MUDL procedure is created (boot)
* The area containing the MUDL procedure is created (boot)
* The mobile containing the MUDL procedure is created
* The procedure's PROC_ENABLED value is set to a non-zero value.

This is the perfect spot to initialize variables in the MUDL script. For mobiles, the constructor is called after the mobile is placed in a room.

= Command Syntax =

<pre>
addproc <room|mobile|area> mudl
setproc <room|mobile|area> ## construct
</pre>

= Global Variables =

The following global variables are available:
{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Name !! Type !! Description
|-
| %c
| Character
| The mobile that the MUDL script is attached to. This value is null if the script is attached to a room or object.
|-
| %o
| Object
| The object that the MUDL script is attached to. This value is null if the script is attached to a room or mobile.
|-
| %room
| Room
| The room in the game where the script is being run. This value may be null if the script is attached to an area and the entry point does not involve a command or player action.
|-
| %area
| Area
| The area (zone) in the game where the script is being run.
|-
| %parent
| Character or Object or Room or Area
| The in-game element that the MUDL script is attached to. It will be identical to one of %c, %o, %room, or %area.
|-
| %procedure_index
| Integer
| The index of the current MUDL procedure on the %parent variable.
|}

= Return Values =

The constructor's return value is ignored.

[[Category:Building]]
[[Category:MUDL|Construct]]

MUDL:time now

2018-11-19T22:49:27Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | time_now |- ! Settable | No |- ! Returns | Integer |} {|class="..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| time_now
|-
! Settable
| No
|-
! Returns
| Integer
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| No parameters
|}

This function returns an integer timestamp equal to the number of seconds elapsed since midnight on Jan 1, 1970.

= Example =
<pre>
setproc <parent> # on_foo
msg_room(%room, 'Time is ' + time_now()),
return(true)
</pre>

[[Category:Building]]
[[Category:MUDL|time_now]]

MUDL:remove pissed

2018-11-19T22:46:29Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | remove_pissed |- ! Settable | No |- ! Returns | Boolean |} {|cl..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| remove_pissed
|-
! Settable
| No
|-
! Returns
| Boolean
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Mobile (character), Player Name (string)
|}

This function removes the player name from the "pissed" list for the specified mobile. If the mobile and string are valid and the mobile was pissed at that name, the function returns True.

= Example =
<pre>
setproc <parent> # on_foo
remove_pissed(char_in_room(%a, 'kobold'), name(%a)),

return(true)
</pre>

[[Category:Building]]
[[Category:MUDL|remove_pissed]]

MUDL:add pissed

2018-11-19T22:45:08Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | add_pissed |- ! Settable | No |- ! Returns | Boolean |} {|class..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| add_pissed
|-
! Settable
| No
|-
! Returns
| Boolean
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Mobile (character), Player Name (string)
|}

This function adds the player name to the "pissed" list for the specified mobile. If the mobile and string are valid and the mobile isn't currently pissed at that name, the function returns True.

= Example =
<pre>
setproc <parent> # on_foo
add_pissed(char_in_room(%a, 'kobold'), name(%a)),

return(true)
</pre>

[[Category:Building]]
[[Category:MUDL|add_pissed]]

MUDL:area

2018-11-08T19:59:14Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | area |- ! Settable | No |- ! Returns | Area |} {|class="abiliti..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| area
|-
! Settable
| No
|-
! Returns
| Area
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Character
|-
| Item
|}

This function returns the area is which the specified Character or Item currently resides.

= Example =
<pre>
setproc <parent> # on_foo
msg_character(%a, 'You are currently in ' +
name(area(%a)) + '.'),
return(true)
</pre>

[[Category:Building]]
[[Category:MUDL|area]]

MUDL:has spell active

2018-11-08T19:45:01Z

Teker:

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| has_spell_active
|-
! Settable
| No
|-
! Returns
| Boolean
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Target (character), Spell (integer)
|}

This function returns True if the Target is currently affected by the specified spell.

= Example =
<pre>
setproc <mobile> # every_round
if (target(%c),
(
if (!has_spell_active(target(%c), spell_id('blindness')),
(
msg_character(target(%c), '$N does something hideous!', %c)
)),
return(true)
}},

return(false)
</pre>

[[Category:Building]]
[[Category:MUDL|has_spell_active]]

MUDL:has spell active

2018-11-08T19:44:19Z

Teker: Teker moved page MUDL:has spell to MUDL:has spell active

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| has_spell_active
|-
! Settable
| No
|-
! Returns
| Boolean
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Target (character), Spell (integer)
|}

This function returns True if the Target is currently affected by the specified spell.

= Example =
<pre>
setproc <mobile> # every_round
if (target(%c),
(
if (!has_spell_active(target(%c), spell_id('blindness')),
(
msg_character(target(%c), '$N does something hideous!', %c),
)),
return(true)
}},

return(false)
</pre>

[[Category:Building]]
[[Category:MUDL|has_spell_active]]

MUDL:has spell

2018-11-08T19:44:19Z

Teker: Teker moved page MUDL:has spell to MUDL:has spell active

#REDIRECT [[MUDL:has spell active]]

MUDL:has spell active

2018-11-08T19:41:51Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | has_spell_active |- ! Settable | No |- ! Returns | Boolean |} {..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| has_spell_active
|-
! Settable
| No
|-
! Returns
| Boolean
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Target (character), Spell (integer)
|}

This function returns True if the Target is currently affected by the specified spell.

= Example =
<pre>
setproc <mobile> # every_round
if (target(%c),
(
if (!has_spell_active(target(%c), spell_id('blindness')),
(
msg_character(target(%c), '$N does something hideous!', %c),
)),
return(true)
}},

return(false)
</pre>

[[Category:Building]]
[[Category:MUDL|has_spell_active]]

MUDL:check saves spell

2018-11-08T19:15:41Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | check_saves_spell |- ! Settable | No |- ! Returns | Boolean |}..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| check_saves_spell
|-
! Settable
| No
|-
! Returns
| Boolean
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Victim (character)
|-
| Victim (character), Attacker (character)
|-
| Victim (character), Attacker (character), Modifier (integer)
|}

This function performs a saving throw roll for the Victim and returns True if the save is successful. If the Attacker is specified, any saving throw modifiers on the Attacker will adjust the roll. In addition, a Modifier can be specified to make the roll easier (positive value) or harder (negative value).

= Example =
<pre>
setproc <mobile> # every_round
if (target(%c),
(
msg_character(target(%c), '$N zaps you with $S spell!', %c),
if (!check_saves_spell(target(%c), %c, 0),
(
damage(target(%c), 10d20)
),
(
damage(target(%c), 5d20)
)),
return(true)
}},

return(false)
</pre>

[[Category:Building]]
[[Category:MUDL|check_saves_spell]]

MUDL:check saves breath

2018-11-08T19:14:31Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | check_saves_breath |- ! Settable | No |- ! Returns | Boolean |}..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| check_saves_breath
|-
! Settable
| No
|-
! Returns
| Boolean
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Victim (character)
|-
| Victim (character), Attacker (character)
|-
| Victim (character), Attacker (character), Modifier (integer)
|}

This function performs a saving throw roll for the Victim and returns True if the save is successful. If the Attacker is specified, any saving throw modifiers on the Attacker will adjust the roll. In addition, a Modifier can be specified to make the roll easier (positive value) or harder (negative value).

= Example =
<pre>
setproc <mobile> # every_round
if (target(%c),
(
msg_character(target(%c), '$N breathes acid at you!', %c),
if (!check_saves_breath(target(%c), %c, 0),
(
damage(target(%c), 10d20)
),
(
damage(target(%c), 5d20)
)),
return(true)
}},

return(false)
</pre>

[[Category:Building]]
[[Category:MUDL|check_saves_breath]]

MUDL:check saves petrification

2018-11-08T19:08:59Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | check_saves_petrification |- ! Settable | No |- ! Returns | Boole..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| check_saves_petrification
|-
! Settable
| No
|-
! Returns
| Boolean
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Victim (character)
|-
| Victim (character), Attacker (character)
|-
| Victim (character), Attacker (character), Modifier (integer)
|}

This function performs a saving throw roll for the Victim and returns True if the save is successful. If the Attacker is specified, any saving throw modifiers on the Attacker will adjust the roll. In addition, a Modifier can be specified to make the roll easier (positive value) or harder (negative value).

= Example =
<pre>
setproc <mobile> # every_round
if (target(%c),
(
if (!check_saves_petrification(target(%c), %c, 0),
(
msg_character(target(%c), '$N has petrified you!', %c),
affect(target(%c), 'petrify',
'location=petrified level=' + level(%c) +
' seconds=120'),

return(true)
))
)),

return(false)
</pre>

[[Category:Building]]
[[Category:MUDL|check_saves_petrification]]

MUDL:check saves poison

2018-11-08T19:06:20Z

Teker: Created page with " __TOC__ = Summary = {|class="abilitiestable" border="0" cellspacing="0" cellpadding="0" ! Function Name | check_saves_poison |- ! Settable | No |- ! Returns | Boolean |}..."

__TOC__

= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| check_saves_poison
|-
! Settable
| No
|-
! Returns
| Boolean
|}

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Parameter Options
|-
| Victim (character)
|-
| Victim (character), Attacker (character)
|-
| Victim (character), Attacker (character), Modifier (integer)
|}

This function performs a saving throw roll for the Victim and returns True if the save is successful. If the Attacker is specified, any saving throw modifiers on the Attacker will adjust the roll. In addition, a Modifier can be specified to make the roll easier (positive value) or harder (negative value).

= Example =
<pre>
setproc <mobile> # every_round
if (target(%c),
(
if (!check_saves_poison(target(%c), %c, 0),
(
msg_character(target(%c), '$N has poisoned you!', %c),
affect(target(%c), 'poison',
'location=str modifier=-2 level=' + level(%c) +
' seconds=193 bitvector=4096'),

return(true)
))
)),

return(false)
</pre>

[[Category:Building]]
[[Category:MUDL|check_saves_poison]]