Script Object - Revision history

Jerethk: /* Object Properties */

2025-09-26T07:14:47Z

Object Properties

@@ Line 145: / Line 145: @@
 * Gets or sets the object's height / world height (float)
 * Usage example: <code>myObj.worldHeight = 9.5;  // this is the same as height</code>
 == Object Methods ==

2025-09-26T06:54:35Z

Enums

2025-09-26T06:41:16Z

Object Methods

@@ Line 154: / Line 154: @@
 Object cutsceneCam = level.getObject("camera9");
 cutsceneCam.setCamera();
 </pre>

2025-09-02T10:24:20Z

setCamera

@@ Line 146: / Line 146: @@
 // add commando logic
 com5.addLogic("commando");
 </pre>

2025-08-30T12:14:00Z

Object Methods

@@ Line 104: / Line 104: @@
 </pre>
-It is always wise to check if an object exists before doing something with it. Objects will often stop existing in Dark Forces (eg. killed enemies, destroyed scenery, ammo items that have been picked up)
+Note: Scripting functions will internally do an ''exists'' check before being executed. Therefore it is not necessary for you to check that an object exists in ForceScript before calling methods on it. If you try to manipulate an object (eg. set its position) that doesn't exist, nothing will happen. If you ''get'' a property from a non-existent object, a default value will be returned (usually zero).
 === isPlayer() ===
@@ Line 117: / Line 119: @@
 // move the death star plans to the same position as the spirit marker
-if (ds.exists())
+ds.matchPosition(target);
 </pre>
@@ Line 129: / Line 128: @@
 // does the same as the above example, but uses the object's name
 ds.matchPosition("spirit7");
 </pre>

2025-08-30T11:51:48Z

Getting objects by name

← Older revision		Revision as of 04:51, 30 August 2025
Line 43:		Line 43:
	{		{
	// Get the mousebot's position and move it eastwards by 20 units		// Get the mousebot's position and move it eastwards by 20 units
	~~float~~ pos = mb1.position;		float3 pos = mb1.position;
	mb1.position = { pos.x + 20, pos.y, pos.z };		mb1.position = { pos.x + 20, pos.y, pos.z };
	}		}

2025-08-30T11:50:48Z

Methods

@@ Line 1: / Line 1: @@
-'''Object Script''' enables manipulation of objects via ForceScript.
+The '''Script Object''' API enables manipulation of objects via ForceScript.
 == Naming of objects ==
@@ Line 33: / Line 33: @@
 * <code>getObject</code>
 * <code>getObjectsByName</code>
 == Object Properties ==
@@ Line 73: / Line 88: @@
 * Gets or sets the object's height / world height (float)
 * Usage example: <code>myObj.worldHeight = 9.5;  // this is the same as height</code>

2025-08-30T11:23:35Z

Object Properties

← Older revision		Revision as of 04:23, 30 August 2025
Line 48:		Line 48:
	myObj.position = {20, 80, -350};		myObj.position = {20, 80, -350};
	</pre>		</pre>

			=== yaw ===
			* Get or set
			* Gets or sets the object's yaw (float)
			* Usage example: <code>myObj.yaw = 120.0;</code>

			=== radius ===
			* Get or set
			* Gets or sets the object's radius / world width (float)
			* Usage example: <code>myObj.radius = 1.5;</code>

			=== worldWidth ===
			* Get or set
			* Gets or sets the object's radius / world width (float)
			* Usage example: <code>myObj.worldWidth = 1.5; // this is the same as radius</code>

			=== height ===
			* Get or set
			* Gets or sets the object's height / world height (float)
			* Usage example: <code>myObj.height = 9.5;</code>

			=== worldHeight ===
			* Get or set
			* Gets or sets the object's height / world height (float)
			* Usage example: <code>myObj.worldHeight = 9.5; // this is the same as height</code>

2025-08-30T09:04:59Z

Properties

← Older revision		Revision as of 02:04, 30 August 2025
Line 33:		Line 33:
	* <code>getObject</code>		* <code>getObject</code>
	* <code>getObjectsByName</code>		* <code>getObjectsByName</code>

			== Object Properties ==

			=== sector ===
			* Get only
			* Gets the object's current sector (<code>Sector</code>)
			* Usage example: <code>Sector troopSector = my_trooper.sector</code>

			=== position ===
			* Get or set
			* Gets or sets the object's position (float3)
			* Usage example: move the object to coordinates x20, y80, z-350
			<pre>
			myObj.position = {20, 80, -350};
			</pre>

2025-08-30T08:52:37Z

Getting objects

← Older revision		Revision as of 01:52, 30 August 2025
Line 28:		Line 28:
	SEQEND		SEQEND
	</pre>		</pre>

			== Getting objects by name ==
			To get objects by their name, use the methods in the [[Level_Script_API#Methods\|Level Script]] API.
			* <code>getObject</code>
			* <code>getObjectsByName</code>