Player Script API

Documentation for TFE Player Script API.

Enums

ITEM enum

PLANS

PHRIK

NAVA

DT_WEAPON

DATATAPE

ITEM10

WEAPON enum

PISTOL

RIFLE

REPEATER

FUSION

MORTAR

CONCUSSION

CANNON

AMMO enum

AMMO_ENERGY

AMMO_POWER

AMMO_DETONATOR

AMMO_SHELL

AMMO_PLASMA

AMMO_MINE

AMMO_MISSILE

Properties

position

• Get or set
• Gets or sets the player's current position (float3)
• You will not be allowed to move the player outside of a sector
• Usage example: get the current player position and change it to 10 units higher altitude

float3 currentPos = player.position;
player.position = {currentPos.x, currentPos.y + 10, currentPos.z};

yaw

• Get or set
• Gets or sets the player's yaw, in degrees (float)
• Usage example: make the player face south
• player.yaw = 180;

velocity

• Get or set
• Gets or sets the player's velocity (float3)
• Usage example: set the player's velocity to 100 north + 100 west

player.velocity = {-100.0, 0, 100.0};

• Usage example: set the player's velocity to 50 upwards and 30 south

player.velocity = {0, 50.0, -30.0};

health

• Get or set
• Gets or sets the player's health (int)
• Usage example: player.health = 80;

shields

• Get or set
• Gets or sets the player's shields (int)
• Usage example: player.shields = 200;

battery

• Get or set
• Gets or sets the player's battery, as a percentage (int)
• Usage example: player.battery = 60; // 60 percent battery will be 3 lights on the HUD

Methods

kill()

• Instantly kill the player
• Usage example: player.kill();

addToHealth(int)

• Add an amount to the player's health
• Parameter: amount (int)
• Usage example: player.addToHealth(-30); // subtract 30 from the player's health

addToShields(int)

• Add an amount to the player's shields
• Parameter: amount (int)
• Usage example: player.addToShields(10);