Differences

This shows you the differences between two versions of the page.

--- place_file_syntax [2025/03/17 15:13] – [Descriptive Text] jeffd
+++ place_file_syntax [2025/03/19 23:52] (current) – [Descriptive Text] jeffd
@@ Line 1: / Line 1: @@
 ====== Place File Synax ======
+[[Place Files]]
+===== Overview =====
+Place files contain:
+  * A Header consisting of one or more Header Lines.
+  * Areas (or Libraries) which serve as namespaces containing:
+    * Locations (each has a mandatory prefix of either Int. or Ext.)
+      * Some Locations may be logically treated as Main Locations comprised of Sub-Locations.
+      * If a slash is present in a Location name, it separates the Main Location from the Sub-Location.
+    * Camera Angles (Named with A-Z,0-9,_)
+    * Package Definitions
 ==== Header Line ====
@@ Line 11: / Line 25: @@
 ==== Comments ====
+Comments may be included anywhere in the .place file:
 <code>
@@ Line 88: / Line 104: @@
 <code>
 PACKAGE "TRAIL" (START):
-  EXT. TRAILHEAD ([FROM ...] AS $START)
+  EXT. TRAILHEAD ([FROM ...] AS *START)
-  WITHIN $PACKAGE:
+  WITHIN *PACKAGE:
   EXT. TRAIL / SWITCHBACK PATH
   EXT. TRAIL / LARGE ROCK
@@ Line 105: / Line 121: @@
 ===== Location Definitions ======
+==== LOCATION DEFAULTS: ====
+This opens up the template for locations defined within this Library or Area that aren't BASED ON any other location. Once this line is encountered, you are in "Location Definition Context" until switching to another context.
+<code>
+LOCATION DEFAULTS:
+A-CAM:  *Filename(*LOCATION), Default(*Filename(*LOCATION))
+</code>
 ==== INT. / EXT. ====
@@ Line 129: / Line 155: @@
 INT. OFFICE
-  You look around to gain your bearings. $DESCRIPTION
+  You look around to gain your bearings. *DESCRIPTION
 </code>
@@ Line 152: / Line 178: @@
 </code>
-==== CAMERA / DELETE CAMERA ====
+==== x-CAM / DELETE x-CAM ====
-To assign cameras to this location.  Note that the same actual camera can be defined AS multiple named cameras, which may be useful (for example) if the coverage area is wider than what had originally been envisioned.  If this location is not the primary subject of the camera, then the purpose of this location on that camera is specified in parenthesis (which is how that camera's definition will refer to the data relating to this location.)
+This is how to assign cameras to a location.  You can use *A-CAM, *B-CAM, etc, to refer to the previously defined value of any CAM.
+Note that the same Camera Angle can be assigned to multiple named CAMs, which may be useful (for example) if the coverage area is wider than what had originally been envisioned.
+If a camera includes visibility of other locations, pass those location names in parenthesis as named parameters to the Camera Angle.
+If the current Location is not the primary subject of the desired camera, you may use POV and the primary Location name to treat that Location as primary, and then list which of the Camera Angle's named parameters the current Location should be passed into (it will be automatically filled in with this current Location's name, which doesn't need to be written in.)
+Note also that each CAM designation may list more than one Camera Angle.  If the game is going to be rendered with more than one rendering engine (i.e., fully 3D vs. Visual Novel style), or if the designatd Camera Angle is disqualified for some other reason (i.e., not supporting a night-time view when the current time is night), then the first available/eligible camera in the list will be used when the given CAM is called for.
+When a location is shown in a scene, and no specific camera angle is specified, the lowest-lettered available camera will be used (usually A-CAM.)
 <code>
-A-CAM: OFFICE_CAM1
+A-CAM: OFFICE
-B-CAM: OFFICE_CAM1
+B-CAM: OFFICE_REVERSE(HALL = "Ext. Office"), *A-CAM
-C-CAM: OFFICE_CAM2 (DISTANCE)
+C-CAM: POV "Ext. Office" OUTSIDE_OFFICE(INTERIOR), OFFICE
 </code>
-To delete an existing Camera from this location. (This does not delete the actual camera definition itself, which remains usable elsewhere in the game code.)
+To delete an existing CAM definition from this location:
 <code>
-DELETE B-CAM
+DELETE C-CAM
+DELETE OFFICE_REVERSE FROM B-CAM
 </code>
-==== @ (EXITS) / DELETE @ ====
+==== @(EXIT) / DELETE @(EXIT) ====
 Defines, edits, or deletes exits in the current location.
@@ Line 188: / Line 225: @@
 </code>
-==== SCOPE LIMITERS ====
-G$ = Ghostwood GL Engine \\
-U$ = Fully 3D Rendering Engine \\
-T$ = Text Adventure Engine \\