ForceScript API Quick Reference: Difference between revisions

From DF21 Wiki
No edit summary
 
Line 121: Line 121:


=== SectorProp ===
=== SectorProp ===
{|
|-
| <code>SECTORPROP_FLOOR_HEIGHT</code>
|-
| <code>SECTORPROP_CEIL_HEIGHT</code>
|-
| <code>SECTORPROP_SECOND_HEIGHT</code>
|-
| <code>SECTORPROP_FLOOR_TEX</code>
|-
| <code>SECTORPROP_CEIL_TEX</code>
|-
| <code>SECTORPROP_AMBIENT</code>
|}


=== Items ===
=== Items ===

Latest revision as of 07:57, 15 November 2026

Basic types

int signed 32-bit integer
uint unsigned 32-bit integer
float 32-bit floating point number
bool boolean
string string

Arrays and vectors

array an array
float2 a vector of 2 floats
float3 a vector of 3 floats
float4 a vector of 3 floats
float2x2 a 2x2 matrix of floats
float3x3 a 3x3 matrix of floats
float4x4 a 4x4 matrix of floats

Dark Forces types

Sector a sector Script Sector
Wall a wall Script Wall
Object a game object (includes the player, NPCs, scenery, 3d models, projectiles, effects/explosions, items, etc.) Script Object
LevelTexture a level texture Script Texture
Elevator an elevator Script Elevator

Special objects

These are special ForceScript objects; there are (normally) only one of each in existence at any time.

Object name Type Description Reference article
game Game Exposes properties and methods on the game currently being played Game Script API
level Level Exposes properties and methods on the currently open level Level Script API
player Player Exposes properties and methods on the player Player Script API

Enums

MessageType

M_TRIGGER
NEXT_STOP
PREV_STOP
DONE
WAKEUP
MASTER_ON
MASTER_OFF
CRUSH

SectorFlags1

WallFlags1

WallFlags3

SectorProp

SECTORPROP_FLOOR_HEIGHT
SECTORPROP_CEIL_HEIGHT
SECTORPROP_SECOND_HEIGHT
SECTORPROP_FLOOR_TEX
SECTORPROP_CEIL_TEX
SECTORPROP_AMBIENT

Items

Weapons

Ammo

PlayerActions

ACTION_MOVE
ACTION_ROTATE
ACTION_FIRE
ACTION_ALL

Projectiles

WallPart

WP_MIDDLE
WP_TOP
WP_BOTTOM
WP_SIGN