Stim/Response Key/Values - Revision history

Frost Salamander: update location of script where stim types are defined

2024-04-09T21:52:14Z

update location of script where stim types are defined

← Older revision		Revision as of 21:52, 9 April 2024
Line 14:		Line 14:

	Key: '''sr_type_N'''		Key: '''sr_type_N'''
	Type of stim (e.g. STIM_WATER). See /script/~~darkmod_stim_response~~.script for a complete list of stim types.		Type of stim (e.g. STIM_WATER). See '''tdm_base01.pk4/script/tdm_stim_response.script''' for a complete list of stim types.

	Key: '''sr_state_N'''		Key: '''sr_state_N'''

Springheel at 15:33, 15 August 2018

2018-08-15T15:33:19Z

← Older revision		Revision as of 15:33, 15 August 2018
Line 1:		Line 1:
	'''Note:''' ''There is now a ~~stim~~/~~response editor~~ accessed via the Dark Radiant entity menu which makes it easier to set these key/values. The editor settings will be shown below next to their equivalent key/values (work in progress.)''		'''Note:''' ''There is now a [[Stim/Response Editor]] accessed via the Dark Radiant entity menu which makes it easier to set these key/values. The editor settings will be shown below next to their equivalent key/values (work in progress.)''

Springheel: /* Stim only */

2018-08-11T17:00:47Z

Stim only

← Older revision		Revision as of 17:00, 11 August 2018
Line 58:		Line 58:

	Key: '''sr_duration_N'''		Key: '''sr_duration_N'''
	This specifies how long the stim is active before it gets disabled. If this is key is empty, the stim has infinite lifetime (apart from being disabled by scripts and such).		This specifies how long the stim is active before it gets disabled. If this is key is empty, the stim has infinite lifetime (apart from being disabled by scripts and such). Changing this value to 2000 will mean the stim is active for 2 seconds (apparently from map start).

	Key: '''sr_time_interval_N'''		Key: '''sr_time_interval_N'''

Springheel at 15:38, 8 August 2018

2018-08-08T15:38:09Z

← Older revision		Revision as of 15:38, 8 August 2018
Line 2:		Line 2:


	''There are some useful notes regarding STIMs here: http://wiki.thedarkmod.com/index.php?title=User:VanishedOne		''There are some useful notes regarding STIMs here: http://wiki.thedarkmod.com/index.php?title=User:VanishedOne''
	''

	I added two new key/vals to stim response, and figured I would document them all here including the new ones.		I added two new key/vals to stim response, and figured I would document them all here including the new ones.

Springheel at 15:37, 8 August 2018

2018-08-08T15:37:59Z

← Older revision		Revision as of 15:37, 8 August 2018
Line 2:		Line 2:


			''There are some useful notes regarding STIMs here: http://wiki.thedarkmod.com/index.php?title=User:VanishedOne
			''
	I added two new key/vals to stim response, and figured I would document them all here including the new ones.		I added two new key/vals to stim response, and figured I would document them all here including the new ones.

Springheel: /* Stim only */

2018-08-07T13:11:11Z

Stim only

← Older revision		Revision as of 13:11, 7 August 2018
Line 23:		Line 23:
	Set to "1" if you want to use the bounds of the entity as the basis for the intersection test. "0" (the default) uses a sphere centered on the entity origin.		Set to "1" if you want to use the bounds of the entity as the basis for the intersection test. "0" (the default) uses a sphere centered on the entity origin.

	''Springheel: I cannot confirm this. After a lot of tests, it seems that the game is measuring the distance from the origin of the stim to the bounds of the response. It looks like the origin of the stim must be [radius + distance] => 5 in order to avoid stimming the response.''		''Springheel: I cannot confirm this. After a lot of tests, it seems that the game is measuring the distance from the origin of the stim to the bounds of the response. It looks like the origin of the stim must be [radius + distance] => 4 in order to avoid stimming the response.''

	Tests intersection between the physical models of entities A and B, where A carries the stim and B perhaps has a response set. Used for 'immersion' in liquids. If A also has a radius set on the stim, the stim can be applied to B when the radius intersects with B's physical model.		Tests intersection between the physical models of entities A and B, where A carries the stim and B perhaps has a response set. Used for 'immersion' in liquids. If A also has a radius set on the stim, the stim can be applied to B when the radius intersects with B's physical model.

Springheel at 00:55, 7 August 2018

2018-08-07T00:55:08Z

← Older revision		Revision as of 00:55, 7 August 2018
Line 23:		Line 23:
	Set to "1" if you want to use the bounds of the entity as the basis for the intersection test. "0" (the default) uses a sphere centered on the entity origin.		Set to "1" if you want to use the bounds of the entity as the basis for the intersection test. "0" (the default) uses a sphere centered on the entity origin.

	''Springheel: I cannot confirm this. After a lot of tests, it seems that the game is measuring the distance from the origin of the stim to the bounds of the response. It looks like the origin of the stim must be [radius + 5] => 5 in order to avoid stimming the response.''		''Springheel: I cannot confirm this. After a lot of tests, it seems that the game is measuring the distance from the origin of the stim to the bounds of the response. It looks like the origin of the stim must be [radius + distance] => 5 in order to avoid stimming the response.''

	Tests intersection between the physical models of entities A and B, where A carries the stim and B perhaps has a response set. Used for 'immersion' in liquids. If A also has a radius set on the stim, the stim can be applied to B when the radius intersects with B's physical model.		Tests intersection between the physical models of entities A and B, where A carries the stim and B perhaps has a response set. Used for 'immersion' in liquids. If A also has a radius set on the stim, the stim can be applied to B when the radius intersects with B's physical model.

Springheel at 00:48, 7 August 2018

2018-08-07T00:48:25Z

← Older revision		Revision as of 00:48, 7 August 2018
Line 23:		Line 23:
	Set to "1" if you want to use the bounds of the entity as the basis for the intersection test. "0" (the default) uses a sphere centered on the entity origin.		Set to "1" if you want to use the bounds of the entity as the basis for the intersection test. "0" (the default) uses a sphere centered on the entity origin.

	''Springheel: I cannot confirm this. After a lot of tests, it seems that the game is measuring the distance from the origin of the stim to the bounds of the response. It looks like the origin of the stim must be [radius + 5] =< 5 in order to avoid stimming the response.''		''Springheel: I cannot confirm this. After a lot of tests, it seems that the game is measuring the distance from the origin of the stim to the bounds of the response. It looks like the origin of the stim must be [radius + 5] => 5 in order to avoid stimming the response.''

	Tests intersection between the physical models of entities A and B, where A carries the stim and B perhaps has a response set. Used for 'immersion' in liquids. If A also has a radius set on the stim, the stim can be applied to B when the radius intersects with B's physical model.		Tests intersection between the physical models of entities A and B, where A carries the stim and B perhaps has a response set. Used for 'immersion' in liquids. If A also has a radius set on the stim, the stim can be applied to B when the radius intersects with B's physical model.

Springheel at 00:47, 7 August 2018

2018-08-07T00:47:37Z

← Older revision		Revision as of 00:47, 7 August 2018
Line 22:		Line 22:
	Key: '''sr_use_bounds_N'''		Key: '''sr_use_bounds_N'''
	Set to "1" if you want to use the bounds of the entity as the basis for the intersection test. "0" (the default) uses a sphere centered on the entity origin.		Set to "1" if you want to use the bounds of the entity as the basis for the intersection test. "0" (the default) uses a sphere centered on the entity origin.

			''Springheel: I cannot confirm this. After a lot of tests, it seems that the game is measuring the distance from the origin of the stim to the bounds of the response. It looks like the origin of the stim must be [radius + 5] =< 5 in order to avoid stimming the response.''

	Tests intersection between the physical models of entities A and B, where A carries the stim and B perhaps has a response set. Used for 'immersion' in liquids. If A also has a radius set on the stim, the stim can be applied to B when the radius intersects with B's physical model.		Tests intersection between the physical models of entities A and B, where A carries the stim and B perhaps has a response set. Used for 'immersion' in liquids. If A also has a radius set on the stim, the stim can be applied to B when the radius intersects with B's physical model.

Springheel: /* Response only */

2016-10-08T15:59:17Z

Response only

← Older revision		Revision as of 15:59, 8 October 2016
Line 90:		Line 90:

	The value this key contains the name of the script function to call. If it's a local script, you must put it in the form of "<script object name>::<local function>" otherwise "<global function name>" works as well.		The value this key contains the name of the script function to call. If it's a local script, you must put it in the form of "<script object name>::<local function>" otherwise "<global function name>" works as well.

			Note: When using the stim/response editor, you must right-click on the Response Effects field in order to enter an effect. Not sure how anyone would know that.

			Also note, responses set on AI persist when the AI goes to ragdoll state.

	== Important note about writing response scripts ==		== Important note about writing response scripts ==