File /std/basic/trap.c

See also:
/std/basic/close_lock.c and setup_trap .c

Written by ceres

Includes

Method index

• query_trap_armed()
  Get whether the trap is armed or not.
• query_trap_data()
  Get data on the basic lock trap.
• query_trap_description()
  Get the trap description text.
• query_trap_difficulty()
  Find out the difficulty of this trap.
• query_trap_effect()
  Get the trap effects.
• query_trap_message()
  Get the trap trigger messages
• query_trap_trigger()
  Get the trigger condition for this trap.
• set_trap_armed(int)
  Set the trap as armed or disarmed.
• setup_trap(int, string, string, mixed, mixed)
  This sets up a basic trap on a lock.

Public Functions

These are functions that everyone can access.

.

query_trap_armed

int query_trap_armed()


Get whether the trap is armed or not.
query_trap_data

mixed * query_trap_data()


Get data on the basic lock trap. Data is returned as a mixed array of stuff. This is really only used for the autoload. :)

• Returns:
  mixed array of trap data.

query_trap_description

string query_trap_description()


Get the trap description text.

• Returns:
  string description of the trap.
  query_trap_difficulty

  int query_trap_difficulty()
  

  
  Find out the difficulty of this trap.
  
  • Returns:
    int difficulty
    query_trap_effect

    mixed query_trap_effect()
    

    
    Get the trap effects.
    
    • Returns:
      mixed either an int (for the damage) or a mixed variable for the effect to add to the triggerer.
      query_trap_message

      mixed query_trap_message()
      

      
      Get the trap trigger messages
      
      • Returns:
        mixed a string or array of messages
        query_trap_trigger

        string query_trap_trigger()
        

        
        Get the trigger condition for this trap.
        
        • Returns:
          string the trigger condition.
          set_trap_armed

          void set_trap_armed(int i)
          

          
          Set the trap as armed or disarmed.
          setup_trap

          void setup_trap(int difficulty,
                          string trigger,
                          string description,
                          mixed message,
                          mixed effect)
          

          
          This sets up a basic trap on a lock. The trap will be triggered when someone locks/unlocks/picks the lock (depending on trigger). If triggered the message will be displayed and the effect will be added to the player.
          
          • Parameters:
            difficulty - skill bonus needed to avoid triggering the trap
            trigger - "unlock", "pick, "open", for which activities should trigger the trap.
            description - a description of the trap for someone who looks at it.
            message - The message to be displayed to the player. If it's an array the first index will be printed to the player the second to the room.
            effect - the effect to be added to the trigerer. If the effect is an int the players hps will be reduced by that amount. If it is a string that effect will be added to the player, if it's an array the first index will be treated as the effect the rest as parameters to the effect.
          • Example:
            

            setup_trap(300, "pick",
                       "Hidden inside the lock is a small ampule which, if touched by "
                       "an unwary tool would trigger a puff of poisonous gas.",
                       ({"A small cloud of gas puffs out of the safe.\n",
                           "A small cloud of gas puffs out of the safe.\n"}),
                       ({"/std/effects/poisons/poison_gas", 600}));