Level Script API

From DF21 Wiki
Revision as of 23:38, 22 March 2025 by Jerethk (talk | contribs)

Documentation for TFE Level Script API.

Properties

minLayer

  • Get only
  • Gets the minimum map layer (signed integer)
  • Usage example: int i = level.minLayer;

maxLayer

  • Get only
  • Gets the maximum map layer (signed integer)
  • Usage example: int i = level.maxLayer;

sectorCount

  • Get only
  • Gets the total count of sectors (signed integer)
  • Usage example: int i = level.sectorCount

secretCount

  • Get only
  • Gets the total count of secrets (signed integer)
  • Usage example: int i = level.secretCount

textureCount

  • Get only
  • Gets the total count of textures (signed integer)
  • Usage example: int i = level.textureCount

elevatorCount

  • Get only
  • Gets the total count of elevators (signed integer)
  • Usage example: int i = level.elevatorCount

parallax

  • Get only
  • Gets the parallax (float2)
  • Usage example:
float2 pa = level.parallax;
float horzParallax = pa.x;
float vertParallax = pa.y;

Special sector getters

bossSector

  • Gets the boss sector (Sector)
  • Usage example: Sector bossSect = level.bossSector;

mohcSector

  • Gets the mohc sector (Sector)
  • Usage example: Sector mohcSect = level.mohcSector;

completeSector

  • Gets the complete sector (Sector)
  • Usage example: Sector completeSect = level.completeSector;

Methods

getSector(int)

  • Returns a sector
  • Parameters: sector Id (int)
  • Usage example: Sector mySector = level.getSector(14);

getElevator(int)

  • Returns an elevator
  • Parameters: elevator Id (int)
  • Usage example: Elevator myElev = level.getElevator(9);