View source for AGIWiki/New room section

{{AGIWiki}}

The '''new room section''' of a [[AGIWiki/Logic|logic]] is a section of code that runs during the first [[AGIWiki/Interpreter cycle|interpreter cycle]] in a new [[AGIWiki/Room|room]] and does not run again unless the player leaves the room and re-enters it. This section is used to perform initialization of the [[AGIWiki/Variable|variables]], [[AGIWiki/Flag|flags]], [[AGIWiki/Animated object|objects]], and other data used by the room - in other words, the new room section contains code that you would only want to run once in a room.

The new room section is controlled by the [[AGIWiki/Special flags|special flag]] <code>f5</code> (or <code>new_room</code>, in the [[AGIWiki/AGI Studio Template Game|AGI Studio Template Game]]). This flag is [[AGIWiki/set|set]] during the first cycle through a new room and is [[AGIWiki/reset|reset]] after that cycle has completed.

A typical new room section will contain code like the following:

<syntax type="C++">
  #define new_room f5
  #define room_no  v0
  #define ego      o0

  if (new_room)
  {
    /* new room section */

    load.pic(room_no);
    draw.pic(room_no);
    discard.pic(room_no);

    draw(ego);
    show.pic();
  }
</syntax>