File /std/basic/move.c

Written by Pinkfish

Includes

Method index

• drop(mixed)
  The current value of the drop flag.
• dwep()
  Dest with extreme predejuce.
• get(mixed)
  The current value of the get flag.
• move(mixed, string, string)
  The basic move method.
• reset_drop()
  Turns off the drop flag.
• reset_get()
  Turns off the get flag.
• set_drop()
  Turns on the drop flag.
• set_get()
  Turns on the get flag.

Public Functions

These are functions that everyone can access.

.

drop

int drop(mixed dest)


The current value of the drop flag. This function is called by the test_remove() function in the living object. So it allows you to move the object out of inanimate objects, just not out of the players.

• Returns:
  1 if it is set, 0 if it is reset
• See also:
  set_drop(), reset_drop() and get()

dwep

nomask mixed dwep()


Dest with extreme predejuce. This is the last way to destruct an object. Used if all other methods fail.

• Returns:
  a string "Destructed With Extreme Prejudice"
  get

  int get(mixed dest)
  

  
  The current value of the get flag. This function is called by the test_add() function in the living object. So it allows you to move the object into innimate objects, just not into player characters.
  
  • Returns:
    1 if it is set, 0 if it is reset
  • See also:
    set_get(), reset_get() and drop()
    move

    varargs int move(mixed dest,
                     string messin,
                     string messout)
    

    
    The basic move method. The destination can be an object or a string. if it is neither of these then the failure MOVE_EMPTY_DEST is returned. If the function test_add() was called on the destination and it returns 0 then MOVE_NO_GET is returned as a failure. If the destination is this_object() then MOVE_INVALID_DEST is returned as the failure. If the function test_remove is called on the current environment and it returns 0 then MOVE_NO_DROP is returned as the move failure.

    The events "enter" and "exit" are generated as part of the move process. Both of these events are passed two arguments. The exit event is passed the exit message and the destination. The enter event is passed the enter message and the place we came from.

    The function event_move_object() is called (call_other) on the object if the move was successful (MOVE_OK).
    

    • Parameters:
      dest - where to move to
      messin - the message to print when entering
      messout - the message to print when leaving
    • Returns:
      MOVE_OK on success, or a failure reason on failure
    • See also:
      /include/move_failures.h, /secure/simul_efun->event() and event_move_object()
    • Example:
      

      move(find_player("pinkfish"));

      
      

      move("/d/am/am/mendeddrum");

      
      

      move (environment(find_player("ceres")),
               the_short()+" flaps in hopelessly.\n",
               the_short()+" flaps away hopelessly.\n");
      

      reset_drop

      void reset_drop()
      

      
      Turns off the drop flag.
      
      • See also:
        move(), set_drop() and drop()
        reset_get

        void reset_get()
        

        
        Turns off the get flag.
        
        • See also:
          move(), set_get() and get()
          set_drop

          void set_drop()
          

          
          Turns on the drop flag.
          
          • See also:
            move(), reset_drop() and drop()
            set_get

            void set_get()
            

            
            Turns on the get flag.
            
            • See also:
              move(), reset_get() and get()