Difference between revisions of "God:Quest Special Functions"

From The Final Challenge Wiki
Jump to navigation Jump to search
(A copy of 'Area Special Functions')
 
(Edited into the bare essentials)
Line 1: Line 1:
The following special functions are available to area writers.   
The following special functions are designed for quests and other special purposes, and would not ordinarily be included in areasSome of these special functions may be risky, should not not be used without consulting Tynian prior to use.  These functions are denoted in the table as 'restricted'.  Others can be used by god+ as necessary to support quests and role play. Use good judgement.
 
All use of special functions should be approved by the [[Area Coordinator]] prior to use.  If code modifications are necessary (e.g. a special function is not [[Generic Special Function|generic]]), the Area Coordinator will also discuss the use of the special function with a coder.
 


==[[Mob Function]]s==
==[[Mob Function]]s==
Line 10: Line 7:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|init_mage
|name
|yes
|yes|no
|Create an arch-mage archmob
|Desc
|-
|init_priest
|yes
|Create archmob cleric
|-
|init_shaman
|yes
|Create archmob shaman
|}
|}


Line 31: Line 20:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|spec_breath_acid
|name
|yes
|yes|no
|Acid breath
|Desc
|-
|spec_breath_any
|yes
|Random dragon breath
|-
|spec_breath_fire
|yes
|Fire breath
|-
|spec_breath_frost
|yes
|Frost breath
|-
|spec_breath_gas
|yes
|Gas breath
|-
|spec_cast_cleric
|yes
|Cast cleric spells
|-
|spec_cast_mage
|yes
|Cast mage spells
|-
|spec_cast_shaman
|yes
|Cast shaman spells
|-
|spec_cast_undead
|yes
|Cast spells associated with undead
|-
|spec_corrosion
|yes
|Cast acid blast and other spells
|-
|spec_demon
|yes
|Demon casting spec
|-
|spec_demon_lord
|yes
|Demon lord casting spec
|-
|spec_fight_dirty
|yes
|Dirty fighting
|-
|spec_fire_demon
|yes
|Fire demon casting spec
|-
|spec_guardian_demon
|yes
|Guardian demon casting spec
|-
|spec_mind_affects
|yes
|Cast mind affect spells
|-
|spec_one_spell
|yes
|Cast a single spell, as set with mob 'O' flag
|-
|spec_pestilence
|yes
|Cast cause disease and other spells
|-
|spec_poison
|yes
|Poison bites
|-
|spec_poison_sting
|yes
|Poison sting
|-
|spec_shadow_demon
|yes
|Shadow demon casting spec
|-
|spec_storm_demon
|yes
|Storm demon casting spec
|}
|}


Line 128: Line 33:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|spec_fido
|name
|yes
|yes|no
|Eat animal corpses.
|Desc
|-
|spec_grudge
|yes
|Will attack PC in room if PC previously attacked mob.
|-
|spec_guard
|no
|Racial guards.
|-
|spec_howl
|yes
|Howling mob.
|-
|spec_immediate_relay
|yes
|Causes mob to immediately return to its start room.
|-
|spec_janitor
|yes
|Pick up trash.
|-
|spec_no_hunt
|yes
|Mob will not use standard hunting.
|-
|spec_respawn
|yes
|Will cause a new instance of a mob to be created immediately upon death of the mob.
|-
|spec_sleeping_dragon
|no
|Provides spec_breath_acid for combat.  Awakens mob, that then ROARS.  Puts dragon asleep again once it thinks it's alone.
|-
|spec_teleport_on_load
|yes
|Teleports mob to random location immediately upon repop.
|-
|spec_thief
|yes
|Mob steals gold.
|}
|}


Line 184: Line 49:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|[[spec_act_on_give]]
|Name
|yes
|yes|no
|Upon giving mob an item of a specific vnum, perform specified action, such as giving PC an item in return, or transfering PC to specified room with optional action description (must be coded if custom description needed)
|Desc
|}
|}


Line 199: Line 64:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|spec_cliff_fall
|Spec
|yes
|yes|no
|Falling down cliff face
|Desc
|-
|spec_fire_bath
|yes
|Engulfing flames
|-
|spec_freefall_one
|yes
|Fall into room in down direction; spec_long_fall invoked
|-
|spec_gas_chamber
|yes
|Choke and gag within room
|-
|spec_mildgas
|yes
|Choke and gag within room (less damage than spec_gas_chamber)
|-
|spec_steam_bath
|yes
|geyser of hot water and steam
|}
|}


Line 231: Line 76:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|spec_lock_down
|Spec
|yes
|yes|no
|Shuts and locks door down
|Desc
|-
|spec_lock_east
|yes
|Shuts and locks door to east
|-
|spec_lock_north
|yes
|Shuts and locks door to north
|-
|spec_lock_south
|yes
|Shuts and locks door to south
|-
|spec_lock_up
|yes
|Shuts and locks door up
|-
|spec_lock_west
|yes
|Shuts and locks door to west
|-
|spec_seal_exits
|yes
|Closes all doors
|-
|spec_shut_down
|yes
|Shuts door down
|-
|spec_shut_east
|yes
|Shuts door to east
|-
|spec_shut_north
|yes
|Shuts door to north
|-
|spec_shut_south
|yes
|Shuts door to south
|-
|spec_shut_up
|yes
|Shuts door up
|-
|spec_shut_west
|yes
|Shuts door to west
|}
|}


Line 291: Line 88:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|spec_crumble_floor
|Spec
|no
|yes|no
|Heavy characters fall through floor to room below
|Desc
|-
|spec_wind_tunnel
|yes
|Room is windy; can blow away items
|}
|}


Line 307: Line 100:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|spec_aircurrent_down
|Spec
|yes
|yes|no
|Wind. Assumes down exit
|Desc
|-
|spec_aircurrent_east
|yes
|Wind. Assumes east exit
|-
|spec_aircurrent_north
|yes
|Wind. Assumes north exit
|-
|spec_aircurrent_south
|yes
|Wind. Assumes south exit
|-
|spec_aircurrent_up
|yes
|Wind. Assumes up exit
|-
|spec_aircurrent_west
|yes
|Wind. Assumes west exit
|-
|spec_airfork_ne
|yes
|Air current to north or east
|-
|spec_airfork_nw
|yes
|Air current to north or west
|-
|spec_airfork_se
|yes
|Air current to south or east
|-
|spec_airfork_sw
|yes
|Air current to south or west
|-
|spec_current_down
|yes
|Assumes down exit
|-
|spec_current_east
|yes
|Assumes water and east exit
|-
|spec_current_north
|yes
|Assumes water and north exit
|-
|spec_current_south
|yes
|Assumes water and south exit
|-
|spec_current_up
|yes
|Assumes up exit
|-
|spec_current_west
|yes
|Assumes water and west exit
|-
|spec_fork_ne
|yes
|Current to north or east
|-
|spec_fork_nw
|yes
|Current to north or west
|-
|spec_fork_se
|yes
|Current to south or east
|-
|spec_fork_sw
|yes
|Current to south or west
|-
|spec_oceancurrent_down
|yes
|Assumes down exit
|-
|spec_oceancurrent_east
|yes
|Assumes east exit
|-
|spec_oceancurrent_north
|yes
|Assumes north exit
|-
|spec_oceancurrent_south
|yes
|Assumes south exit
|-
|spec_oceancurrent_up
|yes
|Assumes up exit
|-
|spec_oceancurrent_west
|yes
|Assumes west exit
|-
|spec_oceanfork_ne
|yes
|-
|spec_oceanfork_nw
|yes
|-
|spec_oceanfork_se
|yes
|-
|spec_oceanfork_sw
|yes
|-
|spec_tide_ew
|yes
|-
|spec_tide_ns
|yes
|-
|spec_waterfall_east
|yes
|spec_current_east + spec_long_fall
|-
|spec_waterfall_north
|yes
|spec_current_north + spec_long_fall
|-
|spec_waterfall_south
|yes
|spec_current_south + spec_long_fall
|-
|spec_waterfall_west
|yes
|spec_current_west + spec_long_fall
|}
|}


Line 454: Line 113:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|[[spec_check_door_open]]
|Spec
|yes
|yes|no
|Checks a stat attribute prior to opening door
|Descr
|}
|}


Line 468: Line 127:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|spec_cavein
|Spec
|no
|yes|no
|Text assumes PC in a tunnel
|Desc
|-
|spec_crack_head
|yes
|Head damage
|-
|spec_long_fall
|yes
|Damage character (can be any direction)
|-
|spec_medium_fall
|yes
|Damage character (can be any direction)
|-
|spec_short_fall
|no
|Minor damage -- text assumes a fall
|}
|}


Line 508: Line 151:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|spec_splash
|Spec
|yes
|yes|no
|Assumes water. Splash size based on weight of ch
|Desc
|-
|spec_teleporter
|no
|Teleport if holding the correct key (Landru). Requires code changes.
|}
|}


Line 526: Line 165:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|spec_evil_only
|Spec
|yes
|yes|no
|Blocks non-evil-aligned PCs from going specific direction
|Desc
|-
|spec_good_only
|yes
|Blocks non-good-aligned PCs from going specific direction
|-
|spec_neutral_only
|yes
|Blocks aligned PCs from going specific direction
|}
|}


Line 546: Line 177:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|spec_bard_only
|Spec
|yes
|yes|no
|Allow only bard to pass
|Desc
|-
|spec_cleric_only
|yes
|Allow only clerics and OMs to pass
|-
|spec_mage_only
|yes
|Allow only mages and bards to pass
|-
|spec_ranger_only
|yes
|Allow only ranger to pass
|-
|spec_shaman_only
|yes
|Allow only shaman to pass
|-
|spec_thief_only
|yes
|Allow only thief, thug and bard to pass
|-
|spec_thug_only
|yes
|Allow only thug to pass
|-
|spec_warrior_only
|yes
|Allow only warrior, ranger, and bard to pass
|-
|spec_warrior_only2
|yes
|Allow only warrior and bard to pass
|}
|}


Line 590: Line 189:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|spec_mudschool_newbies
|Spec
|yes
|yes|no
|Allow only those less than 5th level to pass
|Desc
|}
|}


Line 602: Line 201:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|spec_guild_entrance
|Spec
|yes
|yes|no
|Transports character to guild
|Desc
|-
|spec_vortex_entry
|yes
|Creates vortex portal in specified direction
|-
|spec_vortex_exit
|no
|Creates vortex exit in specified direction
|}
|}


Line 623: Line 214:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|spec_fallin
|Spec
|yes
|yes|no
|Fall into room in 'down' direction (no damage)
|Desc
|}
|}


Line 637: Line 228:
|-
|-
! Function Name
! Function Name
! [[Generic Special Function|Generic]]
! Restricted
! Description
! Description
|-
|-
|[[trig_block_heathen]]
|Spec
|yes
|yes|no
|Allow only followers (and optionally UA and/or mobs) through exit
|Desc
|-
|[[trig_sentinel_mob]]
|yes
|Allow only characters holding an item of specific vnum through exit
|-
|[[trig_time_block]]
|yes
|Prevents characters from using specified exit during specified (mud) hours
|}
|}

Revision as of 19:57, 9 March 2012

The following special functions are designed for quests and other special purposes, and would not ordinarily be included in areas. Some of these special functions may be risky, should not not be used without consulting Tynian prior to use. These functions are denoted in the table as 'restricted'. Others can be used by god+ as necessary to support quests and role play. Use good judgement.

Mob Functions

Mob Special Functions are defined in the #SPECIALS section of an area file.

Archmob

Function Name Restricted Description
name no Desc

Combat

Function Name Restricted Description
name no Desc

Miscellaneous

Function Name Restricted Description
name no Desc

Mob Extended Functions

Mob Extended Special Functions are defined in the #SPECIALS section of an area file.

Miscellaneous

Function Name Restricted Description
Name no Desc

In Room

Room special functions are defined in the #RSPECS section of the area file.

Damage

Function Name Restricted Description
Spec no Desc

Doors

Function Name Restricted Description
Spec no Desc

Miscellaneous

Function Name Restricted Description
Spec no Desc

Movement

Function Name Restricted Description
Spec no Desc

Room Extended Functions

Door

Function Name Restricted Description
Spec no Descr

Trigger After Move

(Exit) triggers are defined in the #TRIGGERS section of the area file.

Damage

Function Name Restricted Description
Spec no Desc

Door

Function Name Generic Description
spec_shut_door yes Closes all doors. Requires a door of name "door" in the room.

Miscellaneous

Function Name Restricted Description
Spec no Desc

Trigger Before Move

(Exit) triggers are defined in the #TRIGGERS section of the area file.

Alignment

Function Name Restricted Description
Spec no Desc

Class

Function Name Restricted Description
Spec no Desc

Level

Function Name Restricted Description
Spec no Desc

Miscellaneous

Function Name Restricted Description
Spec no Desc


Movement

Function Name Restricted Description
Spec no Desc

Extended Trigger Before Move

(Exit) triggers are defined in the #TRIGGERS section of the area file.

Exit Blocks

Function Name Restricted Description
Spec no Desc