Unify and simplify door/container map_enter_p_proc

Ref BGforgeNet/Fallout2_Unofficial_Patch#61
#381

Author: burner1024

scripts_src/abbey/abbilbox.ssl

@@ -67,19 +67,9 @@ end
    the player locks it once more.
 ***************************************************************************************/
 procedure map_enter_p_proc begin
-   //added by killap
-   variable tmp;
-   variable special_item;
-   //end added
+   call map_enter_p_proc_vanilla;
 
-/* Set up the door state when the player first enters the map */
    abbey_bill_box_obj := self_obj;
-   if (local_var(LVAR_Set_Door_Status) == 0) then begin
-       set_local_var(LVAR_Set_Door_Status,1);
-       set_local_var(LVAR_Locked,LOCKED_STATUS);
-       set_local_var(LVAR_Trapped,TRAPPED_STATUS);
-   end
-
    if (unsigned_int_compare(local_var(LVAR_Restock_Time), game_time) < 0) then begin
       variable tmp_box := move_quest_items();
       check_restock_item(PID_BOTTLE_CAPS, 150, 225, 100)
@@ -102,17 +92,6 @@ procedure map_enter_p_proc begin
       call restore_critical_items(tmp_box);
       set_local_var(LVAR_Restock_Time, (10 * ONE_GAME_DAY) + game_time);
    end
-
-   if (local_var(LVAR_Locked) == STATE_ACTIVE) then begin
-      // Ensure that we don't have objects "locked open"
-      if obj_is_open(self_obj) then begin
-        obj_close(self_obj);
-      end
-      // Ensure locked status
-      obj_lock(self_obj);
-   end else begin
-      obj_unlock(self_obj);
-   end
 end
 
 

scripts_src/arroyo/aitemdor.ssl

@@ -74,8 +74,7 @@ end
 ***************************************************************************************/
 
 procedure map_enter_p_proc begin
-
-/* Set up the door state when the player first enters the map */
+   /* Set up the door state when the player first enters the map */
    if (local_var(LVAR_Set_Door_Status) == 0) then begin
        set_local_var(LVAR_Set_Door_Status,1);
        set_local_var(LVAR_Trapped,TRAPPED_STATUS);
@@ -87,12 +86,7 @@ procedure map_enter_p_proc begin
    end
 
     if ( (local_var(LVAR_Locked) == STATE_ACTIVE) and (global_var(GVAR_START_ARROYO_TRIAL) <= TRIAL_NONE) ) then begin //edit by killap - added (global_var(GVAR_START_ARROYO_TRIAL) <= TRIAL_NONE)
-        // Ensure that we don't have objects "locked open"
-        if obj_is_open(self_obj) then begin
-            obj_close(self_obj);
-        end
-        // Ensure locked status
-        obj_lock(self_obj);
+        call close_and_lock_self;
     end else begin
         obj_unlock(self_obj);
         set_local_var(LVAR_Locked,STATE_INACTIVE); //added by killap

scripts_src/brokhill/hscrldr.ssl

@@ -281,26 +281,23 @@ end
 
 procedure map_enter_p_proc begin
 
-/* Set up the door state when the player first enters the map */
+   /* Set up the door state when the player first enters the map */
    if (local_var(LVAR_Set_Door_Status) == 0) then begin
        set_local_var(LVAR_Set_Door_Status,1);
        set_local_var(LVAR_Locked,LOCKED_STATUS);
        set_local_var(LVAR_Trapped,TRAPPED_STATUS);
    end
 
+   // TODO - why?
    //added by killap
    if ( (obj_is_locked(self_obj)) and (local_var(LVAR_Locked) != STATE_ACTIVE) ) then begin
       set_local_var(LVAR_Locked,STATE_ACTIVE);
    end
    //end added
+   // end TODO
 
    if (local_var(LVAR_Locked) == STATE_ACTIVE) then begin
-      // Ensure that we don't have objects "locked open"
-      if obj_is_open(self_obj) then begin
-         obj_close(self_obj);
-      end
-      // Ensure locked status
-      obj_lock(self_obj);
+      call close_and_lock_self;
    end else begin
       obj_unlock(self_obj);
    end

scripts_src/den/diflkbox.ssl

@@ -56,12 +56,8 @@ end
 
 procedure map_enter_p_proc begin
    den_flick_box_obj := self_obj;
-/* Set up the locked state when the player first enters the map */
-   if (local_var(LVAR_Set_Door_Status) == 0) then begin
-       set_local_var(LVAR_Set_Door_Status,1);
-       set_local_var(LVAR_Locked,LOCKED_STATUS);
-       set_local_var(LVAR_Trapped,TRAPPED_STATUS);
-   end
+
+   call map_enter_p_proc_vanilla;
 
    if (unsigned_int_compare(local_var(LVAR_Restock_Time), game_time) < 0) then begin
       variable tmp_box := move_quest_items();
@@ -79,18 +75,6 @@ procedure map_enter_p_proc begin
       call restore_critical_items(tmp_box);
       set_local_var(LVAR_Restock_Time, (random(7,14) * ONE_GAME_DAY) + game_time);
    end
-
-   if (local_var(LVAR_Locked) == STATE_ACTIVE) then begin
-      // Ensure that we don't have objects "locked open"
-      if obj_is_open(self_obj) then begin
-         obj_close(self_obj);
-      end
-      // Ensure locked status
-      obj_lock(self_obj);
-   end else begin
-      obj_unlock(self_obj);
-   end
-
 end
 
 /**************************************************************************************

scripts_src/den/direbbok.ssl

@@ -54,4 +54,4 @@ variable the_line;
       game_time_advance((11 - dude_iq) * (ONE_GAME_HOUR));
       dude_floater(the_line);
    gfade_in(ONE_GAME_SECOND);
-end
+end

scripts_src/generic/ziwoddor.ssl

@@ -475,12 +475,10 @@ it through Mapper. After the door has been unlocked, it will remain as such, unl
 the player locks it once more.
 ***************************************************************************************/
 procedure map_enter_p_proc begin
-    call ensure_no_locked_open;
-
-    /* Don't change door state when player is already on the map */
+    /* Don't change state when player is already on the map */
     if is_loading_game then return;
 
-    // Initial setup runs once per game
+    /* Set up the state vars when the player first enters the map */
     if (local_var(LVAR_Set_Door_Status) == 0) then begin
       set_local_var(LVAR_Set_Door_Status, 1);
       obj_unlock(self_obj);

scripts_src/headers/command.h

@@ -1371,33 +1371,14 @@ variable removed_qty;
 
 // DOORS //
 /**
- * Ensure that we don't have objects "locked open".
- * This shouldn't happen, but apparently does.
- * If we're entering a map, and the object is "locked open", then close it.
- * If we're loading a game, (already on the map) then just unlock.
- */
-procedure ensure_no_locked_open begin
-  // If not "locked open", skip
-  if not (obj_is_open(self_obj) and obj_is_locked(self_obj)) then return;
-
-  // We don't want to close+re-lock the door on game load, that makes gameplay inconsistent. So we just unlock.
-  if is_loading_game then begin
-    obj_unlock(self_obj);
-  end else begin
-    // But if PC enters the map, close+lock is justified.
-    // defensive: if the object is "locked open", then unlock first, otherwise close fails
-    obj_unlock(self_obj);
-    obj_close(self_obj);
-    obj_lock(self_obj);
-  end
-end
-
-/**
- * Optionally closes, then non-optionally locks `self_obj`.
- * So that we don't have objects "locked open".
+ * Ensures that the object is closed and locked.
  */
 procedure close_and_lock_self begin
    if obj_is_open(self_obj) then begin
+      // "Locked open" objects cannot close
+      if obj_is_locked(self_obj) then begin
+         obj_unlock(self_obj);
+      end
       obj_close(self_obj);
    end
    obj_lock(self_obj);

scripts_src/headers/doors_containers.h

@@ -110,6 +110,7 @@ procedure Super_Set_Lockpick_Lock;
 procedure trap_search_result(variable found_trap, variable who);
 procedure real_explosion(variable explosive);
 procedure roll_critical;
+procedure map_enter_p_proc_vanilla;
 /*****************************************************************
 Local Variables which are saved. All Local Variables need to be
 prepended by LVAR_
@@ -1214,6 +1215,28 @@ on your lockpick and traps skills and perception to notice things.
   end
 #endif
 
+/**
+ * Standard door/container map_enter_p_proc, full body split for easy reuse in customized scripts
+ */
+procedure map_enter_p_proc_vanilla begin
+  /* Don't change state when player is already on the map */
+  if is_loading_game then return;
+
+  /* Set up the state vars when the player first enters the map */
+  if (local_var(LVAR_Set_Door_Status) == 0) then begin
+    set_local_var(LVAR_Set_Door_Status, 1);
+    set_local_var(LVAR_Locked, LOCKED_STATUS);
+    set_local_var(LVAR_Trapped, TRAPPED_STATUS);
+  end
+
+  /* Set up the state when the player enters the map */
+  if (local_var(LVAR_Locked) == STATE_ACTIVE) then begin
+    call close_and_lock_self;
+  end else begin
+    obj_unlock(self_obj);
+  end
+end
+
 /***************************************************************************************
 Whenever the map is first entered, this procedure will be called. The main purpose of
 this procedure is to lock the door from the outset, rather than having to worry about
@@ -1222,25 +1245,10 @@ the player locks it once more.
 ***************************************************************************************/
 #ifndef custom_map_enter_p_proc
   procedure map_enter_p_proc begin
-    call ensure_no_locked_open;
-
-    /* Don't change door state when player is already on the map */
-    if is_loading_game then return;
-
-    /* Set up the door state when the player first enters the map */
-    if (local_var(LVAR_Set_Door_Status) == 0) then begin
-      set_local_var(LVAR_Set_Door_Status, 1);
-      set_local_var(LVAR_Locked, LOCKED_STATUS);
-      set_local_var(LVAR_Trapped, TRAPPED_STATUS);
-    end
-
-    if (local_var(LVAR_Locked) == STATE_ACTIVE) then begin
-      call close_and_lock_self;
-    end else begin
-      obj_unlock(self_obj);
-    end
+    call map_enter_p_proc_vanilla;
   end
 #endif
+
 /**************************************************************************************
 This procedure gets called roughly every 30 seconds of real time. It is used to make
 sure that the door does not lock on it's own and that the player will be able to get

scripts_src/klamath/kibbox.ssl

@@ -54,11 +54,7 @@ end
 procedure map_enter_p_proc begin
    /* Set up the door state when the player first enters the map */
    klam_bucknr_box_obj := self_obj;
-   if (local_var(LVAR_Set_Door_Status) == 0) then begin
-       set_local_var(LVAR_Set_Door_Status,1);
-       set_local_var(LVAR_Locked,LOCKED_STATUS);
-       set_local_var(LVAR_Trapped,TRAPPED_STATUS);
-   end
+   call map_enter_p_proc_vanilla;
 
    if (unsigned_int_compare(local_var(LVAR_Restock_Time), game_time) < 0) then begin
       variable tmp_box := move_quest_items();
@@ -82,19 +78,6 @@ procedure map_enter_p_proc begin
       call restore_critical_items(tmp_box);
       set_local_var(LVAR_Restock_Time, (2 * ONE_GAME_DAY) + game_time);
    end
-
-
-   if (local_var(LVAR_Locked) == STATE_ACTIVE) then begin
-      // Ensure that we don't have objects "locked open"
-      if obj_is_open(self_obj) then begin
-         obj_close(self_obj);
-      end
-      // Ensure locked status
-      obj_lock(self_obj);
-   end else begin
-      obj_unlock(self_obj);
-   end
-
 end
 
 /**************************************************************************************

scripts_src/klamath/kidbox.ssl

@@ -54,13 +54,9 @@ end
 ***************************************************************************************/
 
 procedure map_enter_p_proc begin
-/* Set up the door state when the player first enters the map */
    klam_dunton_box_obj := self_obj;
-   if (local_var(LVAR_Set_Door_Status) == 0) then begin
-       set_local_var(LVAR_Set_Door_Status,1);
-       set_local_var(LVAR_Locked,LOCKED_STATUS);
-       set_local_var(LVAR_Trapped,TRAPPED_STATUS);
-   end
+
+   call map_enter_p_proc_vanilla;
 
    if (unsigned_int_compare(local_var(LVAR_Restock_Time), game_time) < 0) then begin
       variable tmp_box := move_quest_items();
@@ -73,18 +69,6 @@ procedure map_enter_p_proc begin
       call restore_critical_items(tmp_box);
       set_local_var(LVAR_Restock_Time, (21 * ONE_GAME_DAY) + game_time);
    end
-
-   if (local_var(LVAR_Locked) == STATE_ACTIVE) then begin
-      // Ensure that we don't have objects "locked open"
-      if obj_is_open(self_obj) then begin
-         obj_close(self_obj);
-      end
-      // Ensure locked status
-      obj_lock(self_obj);
-   end else begin
-      obj_unlock(self_obj);
-   end
-
 end
 
 /**************************************************************************************