Ghostwood

User Tools

Site Tools

Trace:
place_file_syntax

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
place_file_syntax [2025/03/17 15:25] – jeffdplace_file_syntax [2025/03/19 23:52] (current) – [Descriptive Text] jeffd
Line 1: Line 1:
 ====== Place File Synax ====== ====== Place File Synax ======
 +
 +[[Place Files]]
  
 ===== Overview ===== ===== Overview =====
Line 5: Line 7:
 Place files contain: Place files contain:
  
-  * A Header Section+  * A Header consisting of one or more Header Lines.
   * Areas (or Libraries) which serve as namespaces containing:   * Areas (or Libraries) which serve as namespaces containing:
     * Locations (each has a mandatory prefix of either Int. or Ext.)     * Locations (each has a mandatory prefix of either Int. or Ext.)
Line 23: Line 25:
  
 ==== Comments ==== ==== Comments ====
 +
 +Comments may be included anywhere in the .place file:
  
 <code> <code>
Line 100: Line 104:
 <code> <code>
 PACKAGE "TRAIL" (START): PACKAGE "TRAIL" (START):
-  EXT. TRAILHEAD ([FROM ...] AS $START) +  EXT. TRAILHEAD ([FROM ...] AS *START) 
-  WITHIN $PACKAGE:+  WITHIN *PACKAGE:
   EXT. TRAIL / SWITCHBACK PATH   EXT. TRAIL / SWITCHBACK PATH
   EXT. TRAIL / LARGE ROCK   EXT. TRAIL / LARGE ROCK
Line 117: Line 121:
  
 ===== Location Definitions ====== ===== 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. ==== ==== INT. / EXT. ====
  
Line 141: Line 155:
 INT. OFFICE INT. OFFICE
  
-  You look around to gain your bearings. $DESCRIPTION+  You look around to gain your bearings. *DESCRIPTION
 </code> </code>
  
Line 164: Line 178:
 </code> </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> <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> </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> <code>
-DELETE B-CAM+DELETE C-CAM 
 +DELETE OFFICE_REVERSE FROM B-CAM
 </code> </code>
  
-==== @ (EXITS) / DELETE @ ====+==== @(EXIT) / DELETE @(EXIT) ====
  
 Defines, edits, or deletes exits in the current location. Defines, edits, or deletes exits in the current location.
Line 200: Line 225:
 </code> </code>
  
-==== SCOPE LIMITERS ==== 
- 
-G$ = Ghostwood GL Engine \\ 
-U$ = Fully 3D Rendering Engine \\ 
-T$ = Text Adventure Engine \\ 
  
place_file_syntax.1742250320.txt.gz · Last modified: 2025/03/17 15:25 by jeffd
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki