Script Sector

From DF21 Wiki

Properties

floorHeight

  • Get or set

ceilHeight

  • Get or set

secondHeight

  • Get or set

ambient

  • Get or set

wallCount

  • Get only

floorTexture

  • Get or set

ceilTexture

  • Get or set

floorTextureOffset

  • Get or set

ceilTextureOffset

  • Get or set


Methods

isValid()

isFlagSet(int, uint)

clearFlag(int, uint)

setFlag(int, uint)

getCenterXZ()

getWall(int)

sendMessage(MessageType)

  • Sends a message to sector
  • Parameters: MessageType enum
  • Return value: void
  • Valid MessageTypes that can be sent to sectors:
    • M_TRIGGER
    • NEXT_STOP
    • PREV_STOP
    • WAKEUP
    • MASTER_ON
    • MASTER_OFF

Usage example:

Sector myElev = level.getSector("elev1");
myElev.sendMessage(NEXT_STOP);

sendMessage(MessageType, uint)

  • Sends a message to sector with an event
  • Parameters: MessageType enum, event
  • Return value: void
  • Valid MessageTypes are as above.

Usage example:

Sector myElev = level.getSector("elev1");
myElev.sendMessage(NEXT_STOP, 131072);

This is the equivalent of sending a message via INF like this - message: 1 elev1 NEXT_STOP 131072