Subobject and subsystem properties - Revision history

Goober5000: /* Subobject Properties */ elaborate, and add $rvec

2025-04-16T02:27:48Z

Subobject Properties: elaborate, and add $rvec

← Older revision		Revision as of 02:27, 16 April 2025
Line 226:		Line 226:
	* Reads three comma separated ''floats'' enclosed in square or curly brackets. It does not need to be a normalized vector.		* Reads three comma separated ''floats'' enclosed in square or curly brackets. It does not need to be a normalized vector.
	* '''$translation_axis''' can be followed by whitespace, a colon, or an equals sign.}}		* '''$translation_axis''' can be followed by whitespace, a colon, or an equals sign.}}

			===$fvec:===
			{{Table3610\|
			* Defines the forward vector of the orientation matrix for a rotating subsystem. This can be used to create off-axis rotating subsystems or off-axis multipart turrets. (Multiparts with a vertical rotation axis do not need '''$fvec'''/'''$uvec'''/'''$rvec''' specified.)
			* Reads three comma separated ''floats''. It does not need to be a normalized vector.
			* As of 20.2, '''$fvec''' can be followed by whitespace, a colon, or an equals sign.
			* As of 25.0, '''$fvec''' can be specified on its own (without '''$uvec''' or '''$rvec'''), although for certain orientations '''$uvec''' or '''$rvec''' is still necessary.}}

	===$uvec:===		===$uvec:===
	{{Table3610\|		{{Table3610\|
	* Defines the "up~~" direction (~~vector) of a multipart ~~turret~~. Usually it stands perpendicular to the ship surface~~. Doesn't need to be specified for multiparts with a vertical rotation axis~~.		* Defines the up vector of the orientation matrix for a rotating subsystem. This can be used to create off-axis rotating subsystems or off-axis multipart turrets. (Multiparts with a vertical rotation axis do not need '''$fvec'''/'''$uvec'''/'''$rvec''' specified.) Usually it stands perpendicular to the ship surface.
	* Reads three comma separated ''floats''. It does not need to be a normalized vector.		* Reads three comma separated ''floats''. It does not need to be a normalized vector.
	* Forces turret normal into the same as the '''$uvec'''.		* Forces turret normal into the same as the '''$uvec'''.
	* As of 20.2, '''$uvec''' can be followed by whitespace, a colon, or an equals sign.}}		* As of 20.2, '''$uvec''' can be followed by whitespace, a colon, or an equals sign.
			* As of 25.0, '''$rvec''' can be specified in addition, or as an alternative.}}

	===$~~fvec~~:===		===$rvec:===
	{{~~Table3610~~\|		{{Table250\|
	* Defines the ~~direction~~ of the ~~front~~ a multipart ~~turret will be facing~~. ~~Doesn't need to be specified for multiparts~~ with a vertical rotation axis.		* Defines the right vector of the orientation matrix for a rotating subsystem. This can be used to create off-axis rotating subsystems or off-axis multipart turrets. (Multiparts with a vertical rotation axis do not need '''$fvec'''/'''$uvec'''/'''$rvec''' specified.)
	* Reads three comma separated ''floats''. It does not need to be a normalized vector.		* Reads three comma separated ''floats''. It does not need to be a normalized vector.
	* ~~As of 20.2~~, '''$~~fvec~~''' ~~can be followed by whitespace, a colon, or an equals sign~~.}}		* Can be specified in addition, or as an alternative, to '''$uvec'''.}}

	===$lod0_name===		===$lod0_name===

Goober5000: /* $look_at_offset: */

2025-04-16T02:13:40Z

$look_at_offset:

← Older revision		Revision as of 02:13, 16 April 2025
Line 162:		Line 162:
	* Defines an angle offset for a '''$look_at:''' submodel		* Defines an angle offset for a '''$look_at:''' submodel
	* ''Float'' angle in degrees		* ''Float'' angle in degrees
			* Note: if '''$look_at_offset''' is not specified, it will be set to the submodel's initial position. In other words, the initial position is considered to be the default forward direction.
			{{Table250\|
			In 25.0, if the submodel's '''$fvec'''/'''$uvec''' is specified but '''$look_at_offset''' is not, '''$look_at_offset''' is set to 0 instead of the submodel's initial position. In other words, the '''$fvec'''/'''$uvec''' is considered to determine the forward direction.
			}}

	===$special===		===$special===

Asteroth at 20:25, 9 January 2024

2024-01-09T20:25:11Z

← Older revision		Revision as of 20:25, 9 January 2024
Line 243:		Line 243:
	{{Table3615\|		{{Table3615\|
	* Allows thrusters associated with this submodel to follow its rotations.}}		* Allows thrusters associated with this submodel to follow its rotations.}}
			{{Warning\|
			This flag is redundant. This behavior is active regardless of this flag.}}

	[[Category:Modding]]		[[Category:Modding]]

Goober5000: /* Subobject Properties */ additional info, including submodel translation

2022-08-31T00:37:08Z

Subobject Properties: additional info, including submodel translation

@@ Line 154: / Line 154: @@
 *Marks the subobject as a 'dumb rotating submodel' - alternative to $dumb_rotate, with different units
 *Defines the rotation rate for the subobject: the rotational velocity in radians per second (''float'')
 ===$special===
@@ Line 208: / Line 216: @@
 * Reads three comma separated ''floats'' enclosed in square or curly brackets.  It does not need to be a normalized vector.
 * '''$rotation_axis''' can be followed by whitespace, a colon, or an equals sign.}}
 ===$uvec:===

Goober5000: /* Subsystem Properties */ add info, including submodel translation

2022-08-31T00:26:20Z

Subsystem Properties: add info, including submodel translation

← Older revision		Revision as of 00:26, 31 August 2022
Line 7:		Line 7:

	==Subsystem Properties==		==Subsystem Properties==
	* These can be applied to subsystems ~~both with and without separate~~ subobject.		* These can be applied to subsystems, some of which require the subsystem to have an associated subobject.
	{\| border=0 align=right cellpadding=2 cellspacing=1 style="margin: 0 0 1em 1em; background: #202020; border: 1px #AA2020 solid; border-collapse: collapse; font-size: 95%;"		{\| border=0 align=right cellpadding=2 cellspacing=1 style="margin: 0 0 1em 1em; background: #202020; border: 1px #AA2020 solid; border-collapse: collapse; font-size: 95%;"
	! colspan="2" style="color: white; height: 30px; background: #512020; 70%;"\|'''''Key strings and their order for setting subsystems'''''		! colspan="2" style="color: white; height: 30px; background: #512020; 70%;"\|'''''Key strings and their order for setting subsystems'''''
Line 73:		Line 73:
	*Defines the rotation rate for the subsystem: the rotational velocity in radians per second (''float'')		*Defines the rotation rate for the subsystem: the rotational velocity in radians per second (''float'')
	{{Table216\|		{{Table216\|

	===$rotate_accel===		===$rotate_accel===
	*Specifies the acceleration for a rotating or dumb-rotating subobject. If not specified, acceleration is 0.5 radians per second per second (''float'')		*Specifies the acceleration for a rotating or dumb-rotating subobject. If not specified, acceleration is 0.5 radians per second per second (''float'', or ''"instant"'')
	}}		}}

	====$pbank====		====$pbank====
	*Marks the rotation as primary weapon rotation		*Marks the rotation as primary weapon rotation
Line 82:		Line 84:

	====$stepped====		====$stepped====
	*Defines the rotation as an stepped instead of continuous rotation		*Defines the rotation as a stepped instead of continuous rotation

	=====$steps=====		=====$steps=====
	*Defines the number of steps ~~in the animation~~ (''integer'')		*Defines the number of steps per complete rotation (''integer'')
	*Defaults to 8		*Defaults to 8

	=====$t_paused=====		=====$t_paused=====
	*Defines the pause time between steps (''float'')		*Defines the pause time, in seconds, between steps (''float'')
	*Defaults to 2		*Defaults to 2

	=====$t_transit=====		=====$t_transit=====
	*Defines the movement time between pauses (''float'')		*Defines the movement time, in seconds, between pauses (''float'')
	*Defaults to 2		*Defaults to 2

	=====$fraction_accel=====		=====$fraction_accel=====
	*Defines the fraction of the stepped rotation time used for acceleration (''float'')		*Defines the fraction of the stepped rotation time used for acceleration (''float'')
	*Is between 0 .. 0.5		*Must be between 0 .. 0.5
	*Defaults to 0.3		*Defaults to 0.3

			{{Table224\|
			===$translate===
			*Marks the subsystem as a translating subsystem
			*Defines the translation rate for the subsystem: the linear velocity in meters per second (''float'')

			===$translate_rate===
			*Marks the subsystem as a translating subsystem - alternative to $translate
			*Defines the translation rate for the subsystem: the linear velocity in meters per second (''float'')

			===$translate_accel===
			*Specifies the acceleration for a translating subobject. If not specified, acceleration is 0.5 meters per second per second (''float'', or ''"instant"'')

			====$stepped====
			*Defines the translation as a stepped instead of continuous translation

			=====$reverse_after_step=====
			*Defines whether the subsystem should reverse direction after every step (''boolean'')
			*Defaults to true

			=====$step_distance=====
			*Defines the distance, in meters, covered by one complete step (''float'')
			*Defaults to 25

			=====$t_paused=====
			*Defines the pause time, in seconds, between steps (''float'')
			*Defaults to 2

			=====$t_transit=====
			*Defines the movement time, in seconds, between pauses (''float'')
			*Defaults to 2

			=====$fraction_accel=====
			*Defines the fraction of the stepped translation time used for acceleration (''float'')
			*Must be between 0 .. 0.5
			*Defaults to 0.3
			}}

	==Subobject Properties==		==Subobject Properties==

Goober5000: $rotate_accel

2021-11-21T21:57:27Z

$rotate_accel

← Older revision		Revision as of 21:57, 21 November 2021
Line 2:		Line 2:

	==Important notes==		==Important notes==
	* Subobject/subsystem properties data ~~is not~~ parsed in order.		* Subobject/subsystem properties data can be parsed in any order.
	* Occasionally an option may lack a trailing 'terminating character' like ':' or '=' from its description. In these cases any character can be used as the trailing 'terminating character'.		* Occasionally an option may lack a trailing 'terminating character' like ':' or '=' from its description. In these cases any character can be used as the trailing 'terminating character'.
	* Buffer size of 256 is reserved for the characters in properties data.		* Buffer size of 256 is reserved for the characters in properties data.
Line 72:		Line 72:
	*Marks the subsystem as a rotating subsystem - alternative to $rotate, with different units		*Marks the subsystem as a rotating subsystem - alternative to $rotate, with different units
	*Defines the rotation rate for the subsystem: the rotational velocity in radians per second (''float'')		*Defines the rotation rate for the subsystem: the rotational velocity in radians per second (''float'')
			{{Table216\|
			===$rotate_accel===
			*Specifies the acceleration for a rotating or dumb-rotating subobject. If not specified, acceleration is 0.5 radians per second per second (''float'')
			}}
	====$pbank====		====$pbank====
	*Marks the rotation as primary weapon rotation		*Marks the rotation as primary weapon rotation

Goober5000: /* Subobject Properties */

2021-07-14T19:32:00Z

Subobject Properties

← Older revision		Revision as of 19:32, 14 July 2021
Line 99:		Line 99:

	==Subobject Properties==		==Subobject Properties==
	* These can be applied only to subsystem with their own separate subobject.		* These can be applied only to subsystem with their own separate subobject, or subobjects without subsystems.

	===$dumb_rotate:===		===$dumb_rotate:===

Goober5000: /* Subobject Properties */

2021-07-14T19:28:36Z

Subobject Properties

← Older revision		Revision as of 19:28, 14 July 2021
Line 103:		Line 103:
	===$dumb_rotate:===		===$dumb_rotate:===
	* Marks the subobject as a 'dumb rotating submodel' (i.e. a submodel that rotates but doesn't require a corresponding subsystem)		* Marks the subobject as a 'dumb rotating submodel' (i.e. a submodel that rotates but doesn't require a corresponding subsystem)
	* Defines the rotation time: the number of seconds to make a complete rotation (''float'')		* Defines the rotation time for the subobject: the number of seconds to make a complete rotation (''float'')

	===$dumb_rotate_time===		===$dumb_rotate_time===
	*Marks the subobject as a 'dumb rotating submodel' - alternative to $dumb_rotate		*Marks the subobject as a 'dumb rotating submodel' - alternative to $dumb_rotate
	*Defines the rotation time: the number of seconds to make a complete rotation (''float'')		*Defines the rotation time for the subobject: the number of seconds to make a complete rotation (''float'')

	===$dumb_rotate_rate===		===$dumb_rotate_rate===
	*Marks the subobject as a 'dumb rotating submodel' - alternative to $dumb_rotate, with different units		*Marks the subobject as a 'dumb rotating submodel' - alternative to $dumb_rotate, with different units
	*Defines the rotation rate: the rotational velocity in radians per second (''float'')		*Defines the rotation rate for the subobject: the rotational velocity in radians per second (''float'')

	===$special===		===$special===

Goober5000: /* $dumb_rotate: */ additional dumb_rotate fields

2021-07-14T19:27:53Z

$dumb_rotate:: additional dumb_rotate fields

← Older revision		Revision as of 19:27, 14 July 2021
Line 102:		Line 102:

	===$dumb_rotate:===		===$dumb_rotate:===
	* Marks the subobject as 'dumb rotating ~~object~~'		* Marks the subobject as a 'dumb rotating submodel' (i.e. a submodel that rotates but doesn't require a corresponding subsystem)
	* Defines the rotation time (''float'')		* Defines the rotation time: the number of seconds to make a complete rotation (''float'')

			===$dumb_rotate_time===
			*Marks the subobject as a 'dumb rotating submodel' - alternative to $dumb_rotate
			*Defines the rotation time: the number of seconds to make a complete rotation (''float'')

			===$dumb_rotate_rate===
			*Marks the subobject as a 'dumb rotating submodel' - alternative to $dumb_rotate, with different units
			*Defines the rotation rate: the rotational velocity in radians per second (''float'')

	===$special===		===$special===

Goober5000: /* $rotate */ add other rotate definitions

2021-07-14T19:25:06Z

$rotate: add other rotate definitions

← Older revision		Revision as of 19:25, 14 July 2021
Line 63:		Line 63:
	===$rotate===		===$rotate===
	*Marks the subsystem as a rotating subsystem		*Marks the subsystem as a rotating subsystem
	*Defines the rotation time for the subsystem (''float'')		*Defines the rotation time for the subsystem: the number of seconds to make a complete rotation (''float'')

			===$rotate_time===
			*Marks the subsystem as a rotating subsystem - alternative to $rotate
			*Defines the rotation time for the subsystem: the number of seconds to make a complete rotation (''float'')

			===$rotate_rate===
			*Marks the subsystem as a rotating subsystem - alternative to $rotate, with different units
			*Defines the rotation rate for the subsystem: the rotational velocity in radians per second (''float'')

	====$pbank====		====$pbank====