TDM Script Reference/2.06 - Revision history

Grayman: Grayman moved page TDM Script Reference/2.01 to TDM Script Reference/2.06: New release of TDM

2018-05-07T14:49:33Z

Grayman moved page TDM Script Reference/2.01 to TDM Script Reference/2.06: New release of TDM

← Older revision	Revision as of 14:49, 7 May 2018
(No difference)

Grayman at 14:45, 7 May 2018

2018-05-07T14:45:24Z

Show changes

SteveL: SteveL moved page TDM Script Reference to TDM Script Reference/2.01: Updating main article for 2.02

2014-07-08T07:04:16Z

SteveL moved page TDM Script Reference to TDM Script Reference/2.01: Updating main article for 2.02

← Older revision	Revision as of 07:04, 8 July 2014
(No difference)

Greebo: full import

2012-11-20T17:27:16Z

full import

Show changes

Greebo: import doc manually, memory problems...

2012-11-03T16:10:21Z

import doc manually, memory problems...

← Older revision		Revision as of 16:10, 3 November 2012
Line 6,095:		Line 6,095:

	=== idMover ===		=== idMover ===
			==== scriptEvent void accelSound(string sound); ====

			:Sets the sound to be played when the mover accelerates.

			==== scriptEvent void accelTime(float time); ====

			:Sets the acceleration time. Set this acceleration time before initiating a new move.

			==== scriptEvent void accelTo(float speed, float time); ====

			:Initiates an acceleration to the given speed over the given time in seconds.

			==== scriptEvent void activate(entity activator); ====

			:Activates this entity as if it was activated by a trigger.
			::''activator'': the entity that caused the action (usually the player)

			==== scriptEvent void bob(float speed, float phase, vector distance); ====

			:Initiates a translation back and forth along the given vector with the given speed and phase.

			==== scriptEvent void closePortal(); ====

			:Closes the renderer portal associated with this mover.

			==== scriptEvent void decelSound(string sound); ====

			:Sets the sound to be played when the mover decelerates.

			==== scriptEvent void decelTime(float time); ====

			:Sets the deceleration time. Set this deceleration time before initiating a new move.

			==== scriptEvent void decelTo(float speed, float time); ====

			:Initiates a deceleration to the given speed over the given time in seconds.

			==== scriptEvent void disableSplineAngles(); ====

			:Disables aligning the mover with the spline direction.

			==== scriptEvent void enableSplineAngles(); ====

			:Enables aligning the mover with the spline direction.

			==== scriptEvent float getMoveSpeed(); ====

			:Get the movement speed.

			==== scriptEvent float getMoveTime(); ====

			:Gets the movement time.

			==== scriptEvent float isMoving(); ====

			:Returns true if a mover is moving

			==== scriptEvent float isRotating(); ====

			:Returns true if a mover is rotating

			==== scriptEvent void move(float angle, float distance); ====

			:Initiates a translation with the given distance in the given yaw direction. Uses the current speed/time and acceleration and deceleration settings.

			==== scriptEvent void moveSound(string sound); ====

			:Sets the sound to be played when the moving.

			==== scriptEvent void moveTo(entity targetEntity); ====

			:Initiates a translation to the position of an entity. Uses the current speed/time and acceleration and deceleration settings.

			==== scriptEvent void moveToPos(vector pos); ====

			:Initiates a translation to an absolute position. Uses the current speed/time and acceleration and deceleration settings.

			==== scriptEvent void openPortal(); ====

			:Opens the renderer portal associated with this mover.

			==== scriptEvent void removeInitialSplineAngles(); ====

			:Subtracts the initial spline angles to maintain the initial orientation of the mover.

			==== scriptEvent void rotate(vector angleSpeed); ====

			:Initiates a rotation with the given angular speed. Uses the current speed/time and acceleration and deceleration settings.

			==== scriptEvent void rotateDownTo(float axis, float angle); ====

			:Initiates a rotation about the given axis by decreasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

			==== scriptEvent void rotateOnce(vector angles); ====

			:Initiates a rotation towards the current angles plus the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

			==== scriptEvent void rotateTo(vector angles); ====

			:Initiates a rotation towards the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

			==== scriptEvent void rotateUpTo(float axis, float angle); ====

			:Initiates a rotation about the given axis by increasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

			==== scriptEvent void speed(float speed); ====

			:Sets the movement speed. Set this speed before initiating a new move.

			==== scriptEvent void startSpline(entity spline); ====

			:Starts moving along a spline stored on the given entity.

			==== scriptEvent void stopMoving(); ====

			:Stops any translational movement.

			==== scriptEvent void stopRotating(); ====

			:Stops any rotational movement.

			==== scriptEvent void stopSpline(); ====

			:Stops moving along a spline.

			==== scriptEvent void sway(float speed, float phase, vector angles); ====

			:Initiates a rotation back and forth along the given angles with the given speed and phase.

			==== scriptEvent void time(float time); ====

			:Sets the movement time. Set this time before initiating a new move.

	[[Category:Scripting]]		[[Category:Scripting]]

Greebo: import doc manually, memory problems...

2012-11-01T18:37:23Z

import doc manually, memory problems...

← Older revision		Revision as of 18:37, 1 November 2012
Line 6,048:		Line 6,048:

	=== tdmVine ===		=== tdmVine ===
			==== scriptEvent void addDescendant(entity vine); ====

			:Event called using vine.*()

			==== scriptEvent float canWater(); ====

			:Event called using vine.*()

			==== scriptEvent void clearWatered(); ====

			:Event called using vine.*()

			==== scriptEvent entity getPrime(); ====

			:Event called using vine.*()

			==== scriptEvent void scaleVine(float factor); ====

			:Event called using vine.*()

			==== scriptEvent void setPrime(entity vine); ====

			:Event called using vine.*()

			==== scriptEvent void setWatered(); ====

			:Event called using vine.*()

			=== idMoveable ===
			==== scriptEvent void activate(entity activator); ====

			:Activates this entity as if it was activated by a trigger.
			::''activator'': the entity that caused the action (usually the player)

			==== scriptEvent void becomeNonSolid(); ====

			:Makes the moveable non-solid for other entities.

			==== scriptEvent void enableDamage(float enable); ====

			:enable/disable damage

			==== scriptEvent float isAtRest(); ====

			:Returns true if object is not moving

			=== idMover ===

	[[Category:Scripting]]		[[Category:Scripting]]

Greebo: import doc manually, memory problems...

2012-11-01T18:35:45Z

import doc manually, memory problems...

← Older revision		Revision as of 18:35, 1 November 2012
Line 5,998:		Line 5,998:

	:Returns the portal handle.		:Returns the portal handle.

			=== idBeam ===
			==== scriptEvent void activate(entity activator); ====

			:Activates this entity as if it was activated by a trigger.
			::''activator'': the entity that caused the action (usually the player)

			=== idShaking ===
			==== scriptEvent void activate(entity activator); ====

			:Activates this entity as if it was activated by a trigger.
			::''activator'': the entity that caused the action (usually the player)

			=== idEarthQuake ===
			==== scriptEvent void activate(entity activator); ====

			:Activates this entity as if it was activated by a trigger.
			::''activator'': the entity that caused the action (usually the player)

			=== idFuncPortal ===
			==== scriptEvent void activate(entity activator); ====

			:Activates this entity as if it was activated by a trigger.
			::''activator'': the entity that caused the action (usually the player)

			=== idFuncAASPortal ===
			==== scriptEvent void activate(entity activator); ====

			:Activates this entity as if it was activated by a trigger.
			::''activator'': the entity that caused the action (usually the player)

			=== idFuncAASObstacle ===
			==== scriptEvent void activate(entity activator); ====

			:Activates this entity as if it was activated by a trigger.
			::''activator'': the entity that caused the action (usually the player)

			=== idPhantomObjects ===
			==== scriptEvent void activate(entity activator); ====

			:Activates this entity as if it was activated by a trigger.
			::''activator'': the entity that caused the action (usually the player)

			=== idPortalSky ===
			==== scriptEvent void activate(entity activator); ====

			:Activates this entity as if it was activated by a trigger.
			::''activator'': the entity that caused the action (usually the player)

			=== tdmVine ===

	[[Category:Scripting]]		[[Category:Scripting]]

Greebo: import doc manually, memory problems...

2012-11-01T18:34:24Z

import doc manually, memory problems...

← Older revision		Revision as of 18:34, 1 November 2012
Line 5,949:		Line 5,949:
	:Turns the forcefield on and off.		:Turns the forcefield on and off.


			=== idAnimated ===
			==== scriptEvent void activate(entity activator); ====

			:Activates this entity as if it was activated by a trigger.
			::''activator'': the entity that caused the action (usually the player)

			==== scriptEvent void footstep(); ====

			:No description

			==== scriptEvent void launchMissiles(string projectilename, string sound, string launchbone, string targetbone, float numshots, float framedelay); ====

			:Launches a projectile.

			==== scriptEvent void leftFoot(); ====

			:Changes to left foot and plays footstep sound.

			==== scriptEvent void rightFoot(); ====

			:Changes to right foot and plays footstep sound.

			==== scriptEvent void startRagdoll(); ====

			:Switches to a ragdoll taking over the animation.

			=== idStaticEntity ===
			==== scriptEvent void activate(entity activator); ====

			:Activates this entity as if it was activated by a trigger.
			::''activator'': the entity that caused the action (usually the player)

			=== idFuncSmoke ===
			==== scriptEvent void activate(entity activator); ====

			:Activates this entity as if it was activated by a trigger.
			::''activator'': the entity that caused the action (usually the player)

			=== idVacuumSeparatorEntity ===
			==== scriptEvent void activate(entity activator); ====

			:Activates this entity as if it was activated by a trigger.
			::''activator'': the entity that caused the action (usually the player)

			=== idLocationSeparatorEntity ===
			==== scriptEvent float getPortalHandle(); ====

			:Returns the portal handle.

	[[Category:Scripting]]		[[Category:Scripting]]

Greebo: import doc manually, memory problems...

2012-11-01T18:31:24Z

import doc manually, memory problems...

@@ Line 5,909: / Line 5,909: @@
 :flame is now smoking (1), or not (0)
 ::''state'': 1 = smoking, 0 = not smoking
 [[Category:Scripting]]

Greebo: import doc manually, memory problems...

2012-11-01T18:28:14Z

import doc manually, memory problems...

← Older revision		Revision as of 18:28, 1 November 2012
Line 5,855:		Line 5,855:
	==== scriptEvent float '''getLightLevel'''(); ====		==== scriptEvent float '''getLightLevel'''(); ====

			:Get level (intensity) of a light, <= 0.0 indicates it is off

			==== scriptEvent vector '''getLightOrigin'''(); ====

			:Get the light origin (independent of its visual model)

			==== scriptEvent float '''getLightParm'''(float parmNum); ====

			:Gets a shader parameter.

			==== scriptEvent vector '''getRadius'''(); ====

			:Returns the light radius.

			==== scriptEvent void '''Off'''(); ====

			:Turns the entity off.

			==== scriptEvent void '''On'''(); ====

			:Turns the entity on.

			==== scriptEvent void '''setLightOrigin'''(vector pos); ====

			:Set origin of lights independent of model origin

			==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

			:Sets a shader parameter.

			==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

			:Sets the red/green/blue/alpha shader parms on the light and the model.

			==== scriptEvent void '''setRadius'''(float radius); ====

			:Sets the size of the bounding box, x=y=z=radius.

			==== scriptEvent void '''setRadiusXYZ'''(float x, float y, float z); ====

			:Sets the width/length/height of the light bounding box.

			==== scriptEvent void '''setShader'''(string shader); ====

			:Sets the shader to be used for the light.

			==== scriptEvent void '''setStartedOff'''(); ====

			:no description

			==== scriptEvent void '''smoking'''(float state); ====

			:flame is now smoking (1), or not (0)
			::''state'': 1 = smoking, 0 = not smoking


	[[Category:Scripting]]		[[Category:Scripting]]