Player Script API - Revision history

Jerethk: setCamera

2025-09-02T10:21:10Z

setCamera

← Older revision		Revision as of 03:21, 2 September 2025
Line 124:		Line 124:
	* Instantly kill the player		* Instantly kill the player
	* Usage example: <code>player.kill();</code>		* Usage example: <code>player.kill();</code>

			=== setCamera() ===
			* Move the camera (EYE) to the player
			* Usage: <code>player.setCamera();</code>

	=== disableActions(PlayerActions) ===		=== disableActions(PlayerActions) ===

Jerethk: /* Properties */

2025-04-18T03:04:05Z

Properties

@@ Line 108: / Line 108: @@
 * Gets or sets the player's battery, as a percentage (int)
 * Usage example: <code>player.battery = 60;     // 60 percent battery will be 3 lights on the HUD</code>
 == Methods ==

Jerethk: /* Methods */

2025-04-18T02:59:24Z

Methods

← Older revision		Revision as of 19:59, 17 April 2025
Line 115:		Line 115:
	* Usage example: <code>player.kill();</code>		* Usage example: <code>player.kill();</code>

	=== disableActions(~~PlayerAction~~) ===		=== disableActions(PlayerActions) ===
	* Disable the player's actions		* Disable the player's actions
	* Parameter: actions to disable (<code>PlayerAction</code> enum) - note these can be added together		* Parameter: actions to disable (<code>PlayerAction</code> enum) - note these can be added together
Line 121:		Line 121:
	<pre>		<pre>
	player.disableActions(ACTION_MOVE \| ACTION_FIRE);		player.disableActions(ACTION_MOVE \| ACTION_FIRE);
			</pre>

			Disable all actions (movement, rotation and firing)
			<pre>
			player.disableActions(ACTION_ALL);
			</pre>

			=== enableActions(PlayerActions) ===
			* Enable the player's actions if they have been disabled
			* Parameter: actions to enable (<code>PlayerAction</code> enum) - note these can be added together
			* Usage example: enable player's movement and rotation
			<pre>
			player.enableActions(ACTION_MOVE \| ACTION_ROTATE);
	</pre>		</pre>

Jerethk: /* Methods */

2025-04-18T02:53:13Z

Methods

← Older revision		Revision as of 19:53, 17 April 2025
Line 114:		Line 114:
	* Instantly kill the player		* Instantly kill the player
	* Usage example: <code>player.kill();</code>		* Usage example: <code>player.kill();</code>

			=== disableActions(PlayerAction) ===
			* Disable the player's actions
			* Parameter: actions to disable (<code>PlayerAction</code> enum) - note these can be added together
			* Usage example: disable player's movement and weapon firing
			<pre>
			player.disableActions(ACTION_MOVE \| ACTION_FIRE);
			</pre>

	=== addToHealth(int) ===		=== addToHealth(int) ===

Jerethk: /* PlayerActions enum */

2025-04-18T02:47:01Z

PlayerActions enum

← Older revision		Revision as of 19:47, 17 April 2025
Line 55:		Line 55:
	\|}		\|}

	==== <code>~~PlayerActions~~</code> enum ====		==== <code>PlayerAction</code> enum ====
	{\|		{\|
	\|-		\|-

Jerethk: /* Enums */

2025-04-18T02:46:35Z

Enums

@@ Line 53: / Line 53: @@
 |-
 | AMMO_MISSILE
 |}

Jerethk: /* Methods */

2025-04-01T11:03:25Z

Methods

← Older revision		Revision as of 04:03, 1 April 2025
Line 183:		Line 183:
	=== removeMask() ===		=== removeMask() ===
	* removes the gas mask from the player's inventory		* removes the gas mask from the player's inventory

			=== giveCodeKey(int) ===
			* adds a code key to the inventory
			* Parameter: number of code key (1 to 9)
			* Usage example: <code>player.giveCodeKey(4);</code>

			=== giveItem(ITEM) ===
			* adds an item to the player's inventory
			* Parameter: item type (see <code>ITEM</code> enum)
			* Usage example: <code>player.giveItem(PHRIK)</code>

			=== hasWeapon(WEAPON) ===
			* returns <code>true</code> if the player has the weapon
			* Parameter: weapon type (see <code>WEAPON</code> enum)
			* Usage example:
			<pre>
			if (player.hasWeapon(FUSION))
			{
			....
			}
			</pre>

			=== giveWeapon(WEAPON) ===
			* gives the player a weapon
			* Parameter: weapon type (see <code>WEAPON</code> enum)
			* Usage example: <code>player.giveWeapon(CONCUSSION);</code>

			=== removeWeapon(WEAPON) ===
			* removes a weapon from the player's inventory
			* Parameter: weapon type (see <code>WEAPON</code> enum)
			* Usage example: <code>player.removeWeapon(RIFLE);</code>

Jerethk: /* Methods */

2025-04-01T10:54:31Z

Methods

← Older revision		Revision as of 03:54, 1 April 2025
Line 122:		Line 122:
	* Parameters: ammo type (AMMO enum), value (int)		* Parameters: ammo type (AMMO enum), value (int)
	* Usage example: <code>player.setAmmo(AMMO_PLASMA, 200); // set plasma ammo to 200</code>		* Usage example: <code>player.setAmmo(AMMO_PLASMA, 200); // set plasma ammo to 200</code>

			=== hasRedKey() ===
			* returns <code>true</code> if the player has the red key
			* Usage example:
			<pre>if (player.hasRedKey())
			{
			....
			} </pre>

			=== hasBlueKey() ===
			* returns <code>true</code> if the player has the blue key

			=== hasYellowKey() ===
			* returns <code>true</code> if the player has the yellow key

			=== hasGoggles() ===
			* returns <code>true</code> if the player has the IR Goggles

			=== hasCleats() ===
			* returns <code>true</code> if the player has the ice cleats

			=== hasMask() ===
			* returns <code>true</code> if the player has the gasmask

			=== giveRedKey() ===
			* adds the red key to the player's inventory
			* usage example: <code>player.giveRedKey();</code>

			=== giveBlueKey() ===
			* adds the blue key to the player's inventory

			=== giveYellowKey() ===
			* adds the yellow key to the player's inventory

			=== giveGoggles() ===
			* adds the IR Goggles to the player's inventory

			=== giveCleats() ===
			* adds the ice cleats to the player's inventory

			=== giveMask() ===
			* adds the gas mask to the player's inventory

			=== removeRedKey() ===
			* removes the red key from the player's inventory
			* usage example: <code>player.removeRedKey();</code>

			=== removeBlueKey() ===
			* removes the blue key from the player's inventory

			=== removeYellowKey() ===
			* removes the yellow key from the player's inventory

			=== removeGoggles() ===
			* removes the IR Goggles key from the player's inventory

			=== removeCleats() ===
			* removes the ice cleats from the player's inventory

			=== removeMask() ===
			* removes the gas mask from the player's inventory

Jerethk: /* Methods */

2025-04-01T10:42:58Z

Methods

← Older revision		Revision as of 03:42, 1 April 2025
Line 112:		Line 112:
	* Parameter: amount (int)		* Parameter: amount (int)
	* Usage example: <code>player.addToShields(10);</code>		* Usage example: <code>player.addToShields(10);</code>

			=== getAmmo(AMMO) ===
			* returns the current amount of ammo (int)
			* Parameter: ammo type (AMMO enum)
			* Usage example: <code>int shells = player.getAmmo(AMMO_SHELL);</code>

			=== setAmmo(AMMO, int) ===
			* sets the ammo to a value
			* Parameters: ammo type (AMMO enum), value (int)
			* Usage example: <code>player.setAmmo(AMMO_PLASMA, 200); // set plasma ammo to 200</code>

Jerethk at 16:27, 28 March 2025

2025-03-28T16:27:53Z

@@ Line 69: / Line 69: @@
 === yaw ===
 * Get or set
-* Gets or sets the player's yaw (float in degrees)
+* Gets or sets the player's yaw, in degrees (float)
 * Usage example: make the player face south
 * <code>player.yaw = 180;</code>
@@ Line 81: / Line 81: @@
 * Usage example: set the player's velocity to 50 upwards and 30 south
 <pre>player.velocity = {0, 50.0, -30.0};</pre>
 == Methods ==
-=== kill ===
+=== kill() ===
 * Instantly kill the player
 * Usage example: <code>player.kill();</code>