Prototype/FluidStream - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:51Z

Removed old prototype docs

← Older revision		Revision as of 14:32, 25 October 2024
Line 2:		Line 2:

	</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>		</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>



	~~{{Prototype parent\|Prototype/Entity}}~~
	~~Used for example for the handheld flamethrower.~~

	~~{{Prototype TOC\|stream}}~~

	~~== Mandatory properties ==~~
	~~This prototype inherits all the properties from [[Prototype/Entity]].~~

	~~{{Prototype property\|particle_spawn_interval\|[[Types/uint16\|uint16]]}}~~
	The stream will spawn one particle every <code>particle_spawn_interval</code> ticks until the <code>particle_spawn_timeout</code> is reached. The first particle will trigger an <code>initial_action</code> upon landing. Each particle triggers an <code>action</code> upon landing. Particles spawned within a single <code>particle_spawn_timeout</code> interval will be connected by a stretched <code>spine_animation</code>.

	~~{{Prototype property\|particle_horizontal_speed\|[[Types/double\|double]]}}~~
	~~Must be larger than 0. <code>particle_horizontal_speed</code> has to be greater than <code>particle_horizontal_speed_deviation</code>.~~

	~~{{Prototype property\|particle_horizontal_speed_deviation\|[[Types/double\|double]]}}~~

	~~{{Prototype property\|particle_vertical_acceleration\|[[Types/double\|double]]}}~~

	~~== Optional properties ==~~

	~~{{Prototype property\|initial_action\|[[Types/Trigger\|Trigger]]\|optional=true}}~~
	~~Action that is triggered when the first particle lands.~~

	~~{{Prototype property\|action\|[[Types/Trigger\|Trigger]]\|optional=true}}~~
	~~Action that is triggered every time a particle lands. Not triggered for the first particle if <code>initial_action</code> is non-empty.~~

	~~{{Prototype property\|special_neutral_target_damage\|[[Types/DamagePrototype\|DamagePrototype]]\|optional=true}}~~

	~~{{Prototype property\|width\|[[Types/float\|float]]\|0.5\|optional=true}}~~

	~~{{Prototype property\|particle_buffer_size\|[[Types/uint32\|uint32]]\|20\|optional=true}}~~
	~~Number of spawned child particles of the stream. Must be greater than 0 and less than 256.~~

	~~{{Prototype property\|particle_spawn_timeout\|[[Types/uint16\|uint16]]\|4 * <code>particle_spawn_interval</code>\|optional=true}}~~

	~~{{Prototype property\|particle_start_alpha\|[[Types/float\|float]]\|1\|optional=true}}~~

	~~{{Prototype property\|particle_end_alpha\|[[Types/float\|float]]\|1\|optional=true}}~~

	~~{{Prototype property\|particle_start_scale\|[[Types/float\|float]]\|1\|optional=true}}~~

	~~{{Prototype property\|particle_alpha_per_part\|[[Types/float\|float]]\|1\|optional=true}}~~

	~~{{Prototype property\|particle_scale_per_part\|[[Types/float\|float]]\|1\|optional=true}}~~

	~~{{Prototype property\|particle_fade_out_threshold\|[[Types/float\|float]]\|1\|optional=true}}~~
	~~Value between 0 and 1.~~

	~~{{Prototype property\|particle_loop_exit_threshold\|[[Types/float\|float]]\|0\|optional=true}}~~
	~~Value between 0 and 1.~~

	~~{{Prototype property\|particle_loop_frame_count\|[[Types/uint16\|uint16]]\|1\|optional=true}}~~
	~~Will be set to 1 by the game if less than 1.~~

	~~{{Prototype property\|particle_fade_out_duration\|[[Types/uint16\|uint16]]\|max uint16 (65553)\|optional=true}}~~
	~~Will be set to 1 by the game if less than 1.~~

	~~{{Prototype property\|spine_animation\|[[Types/Animation\|Animation]]\|optional=true}}~~

	~~{{Prototype property\|particle\|[[Types/Animation\|Animation]]\|optional=true}}~~

	~~{{Prototype property\|shadow\|[[Types/Animation\|Animation]]\|optional=true}}~~

	~~{{Prototype property\|smoke_sources\|[[Types/table\|table]] of [[Types/SmokeSource\|SmokeSource]]\|optional=true}}~~
	~~Smoke spawning is controlled by <code>progress_to_create_smoke</code>.~~

	~~{{Prototype property\|progress_to_create_smoke\|[[Types/float\|float]]\|0.5\|optional=true}}~~
	~~The point in the particles projectile arc to start spawning smoke. 0.5 (the default) starts spawning smoke at the halfway point between the source and target.~~

	~~{{Prototype property\|stream_light\|[[Types/LightDefinition\|LightDefinition]]\|optional=true}}~~

	~~{{Prototype property\|ground_light\|[[Types/LightDefinition\|LightDefinition]]\|optional=true}}~~

	~~{{Prototype property\|target_position_deviation\|[[Types/double\|double]]\|0\|optional=true}}~~

	~~{{Prototype property\|oriented_particle\|[[Types/bool\|bool]]\|false\|optional=true}}~~

	~~{{Prototype property\|shadow_scale_enabled\|[[Types/bool\|bool]]\|false\|optional=true}}~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:43:04Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:43, 21 September 2023
Line 1:		Line 1:
	'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/FluidStreamPrototype.html https://lua-api.factorio.com/latest/prototypes/FluidStreamPrototype.html]		<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/FluidStreamPrototype.html https://lua-api.factorio.com/latest/prototypes/FluidStreamPrototype.html]

	This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].		</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>

BilkaBot: Protected "Prototype/FluidStream": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:52:29Z

Protected "Prototype/FluidStream": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision		Revision as of 17:52, 16 August 2023
(No difference)

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:52:29Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:52, 16 August 2023
Line 1:		Line 1:
			'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/FluidStreamPrototype.html https://lua-api.factorio.com/latest/prototypes/FluidStreamPrototype.html]

			This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].



	{{Prototype parent\|Prototype/Entity}}		{{Prototype parent\|Prototype/Entity}}
	Used for example for the handheld flamethrower.		Used for example for the handheld flamethrower.

Bilka: word

2022-11-07T11:36:39Z

word

← Older revision		Revision as of 11:36, 7 November 2022
Line 23:		Line 23:

	{{Prototype property\|action\|[[Types/Trigger\|Trigger]]\|optional=true}}		{{Prototype property\|action\|[[Types/Trigger\|Trigger]]\|optional=true}}
	Action that is triggered every time a particle lands. Not triggered for the first particle if <code>initial_action</code> is ~~defined~~.		Action that is triggered every time a particle lands. Not triggered for the first particle if <code>initial_action</code> is non-empty.

	{{Prototype property\|special_neutral_target_damage\|[[Types/DamagePrototype\|DamagePrototype]]\|optional=true}}		{{Prototype property\|special_neutral_target_damage\|[[Types/DamagePrototype\|DamagePrototype]]\|optional=true}}

Bilka: action won't happen for the first particle if initial_action happened

2022-11-07T11:34:17Z

action won't happen for the first particle if initial_action happened

← Older revision		Revision as of 11:34, 7 November 2022
Line 23:		Line 23:

	{{Prototype property\|action\|[[Types/Trigger\|Trigger]]\|optional=true}}		{{Prototype property\|action\|[[Types/Trigger\|Trigger]]\|optional=true}}
	Action that is triggered every time a particle lands.		Action that is triggered every time a particle lands. Not triggered for the first particle if <code>initial_action</code> is defined.

	{{Prototype property\|special_neutral_target_damage\|[[Types/DamagePrototype\|DamagePrototype]]\|optional=true}}		{{Prototype property\|special_neutral_target_damage\|[[Types/DamagePrototype\|DamagePrototype]]\|optional=true}}

Bilka: formatting

2022-11-07T11:31:51Z

formatting

Raspberrypuppies: /* Optional properties */

2022-09-29T22:47:31Z

Optional properties

← Older revision		Revision as of 22:47, 29 September 2022
Line 20:		Line 20:

	{{Prototype property\|initial_action\|[[Types/Trigger\|Trigger]]\|optional=true}}		{{Prototype property\|initial_action\|[[Types/Trigger\|Trigger]]\|optional=true}}
			Action that is triggered when the first particle lands

	{{Prototype property\|action\|[[Types/Trigger\|Trigger]]\|optional=true}}		{{Prototype property\|action\|[[Types/Trigger\|Trigger]]\|optional=true}}
			Action that is triggered every time a particle lands

	{{Prototype property\|special_neutral_target_damage\|[[Types/DamagePrototype\|DamagePrototype]]\|optional=true}}		{{Prototype property\|special_neutral_target_damage\|[[Types/DamagePrototype\|DamagePrototype]]\|optional=true}}
Line 61:		Line 63:

	{{Prototype property\|smoke_sources\|[[Types/table\|table]] of [[Types/SmokeSource\|SmokeSource]]\|optional=true}}		{{Prototype property\|smoke_sources\|[[Types/table\|table]] of [[Types/SmokeSource\|SmokeSource]]\|optional=true}}
			Smoke spawning is controlled by progress_to_create_smoke

	{{Prototype property\|progress_to_create_smoke\|[[Types/float\|float]]\|0.5\|optional=true}}		{{Prototype property\|progress_to_create_smoke\|[[Types/float\|float]]\|0.5\|optional=true}}
			The point in the particles projectile arc to start spawning smoke. 0.5 (the default) starts spawning smoke at the halfway point between the source and target.

	{{Prototype property\|stream_light\|[[Types/LightDefinition\|LightDefinition]]\|optional=true}}		{{Prototype property\|stream_light\|[[Types/LightDefinition\|LightDefinition]]\|optional=true}}

Raspberrypuppies: /* Mandatory properties */

2022-09-29T22:43:48Z

Mandatory properties

← Older revision		Revision as of 22:43, 29 September 2022
Line 8:		Line 8:

	{{Prototype property\|particle_spawn_interval\|[[Types/uint16\|uint16]]}}		{{Prototype property\|particle_spawn_interval\|[[Types/uint16\|uint16]]}}
			The stream will spawn one particle every particle_spawn_interval ticks until the particle_spawn_timeout is reached. The first particle will trigger an initial_action upon landing. Each particle triggers an action upon landing. Particles spawned within a single particle_spawn_timeout interval will be connected by a stretched spine_animation.

	{{Prototype property\|particle_horizontal_speed\|[[Types/double\|double]]}}		{{Prototype property\|particle_horizontal_speed\|[[Types/double\|double]]}}

Honktown: /* Optional properties */ particle_buffer_size detail

2022-06-14T21:38:52Z

Optional properties: particle_buffer_size detail

← Older revision		Revision as of 21:38, 14 June 2022
Line 27:		Line 27:

	{{Prototype property\|particle_buffer_size\|[[Types/uint32\|uint32]]\|20\|optional=true}}		{{Prototype property\|particle_buffer_size\|[[Types/uint32\|uint32]]\|20\|optional=true}}
	~~Has to~~ be less than 256.		Number of spawned child particles of the stream. Must be greater than 0 and less than 256.

	{{Prototype property\|particle_spawn_timeout\|[[Types/uint16\|uint16]]\|4 * <code>particle_spawn_interval</code>\|optional=true}}		{{Prototype property\|particle_spawn_timeout\|[[Types/uint16\|uint16]]\|4 * <code>particle_spawn_interval</code>\|optional=true}}

← Older revision		Revision as of 14:32, 25 October 2024
Line 2:		Line 2:

	</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>		</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>



	~~{{Prototype parent\|Prototype/Entity}}~~
	~~Used for example for the handheld flamethrower.~~

	~~{{Prototype TOC\|stream}}~~

	~~== Mandatory properties ==~~
	~~This prototype inherits all the properties from [[Prototype/Entity]].~~

	~~{{Prototype property\|particle_spawn_interval\|[[Types/uint16\|uint16]]}}~~
	The stream will spawn one particle every <code>particle_spawn_interval</code> ticks until the <code>particle_spawn_timeout</code> is reached. The first particle will trigger an <code>initial_action</code> upon landing. Each particle triggers an <code>action</code> upon landing. Particles spawned within a single <code>particle_spawn_timeout</code> interval will be connected by a stretched <code>spine_animation</code>.

	~~{{Prototype property\|particle_horizontal_speed\|[[Types/double\|double]]}}~~
	~~Must be larger than 0. <code>particle_horizontal_speed</code> has to be greater than <code>particle_horizontal_speed_deviation</code>.~~

	~~{{Prototype property\|particle_horizontal_speed_deviation\|[[Types/double\|double]]}}~~

	~~{{Prototype property\|particle_vertical_acceleration\|[[Types/double\|double]]}}~~

	~~== Optional properties ==~~

	~~{{Prototype property\|initial_action\|[[Types/Trigger\|Trigger]]\|optional=true}}~~
	~~Action that is triggered when the first particle lands.~~

	~~{{Prototype property\|action\|[[Types/Trigger\|Trigger]]\|optional=true}}~~
	~~Action that is triggered every time a particle lands. Not triggered for the first particle if <code>initial_action</code> is non-empty.~~

	~~{{Prototype property\|special_neutral_target_damage\|[[Types/DamagePrototype\|DamagePrototype]]\|optional=true}}~~

	~~{{Prototype property\|width\|[[Types/float\|float]]\|0.5\|optional=true}}~~

	~~{{Prototype property\|particle_buffer_size\|[[Types/uint32\|uint32]]\|20\|optional=true}}~~
	~~Number of spawned child particles of the stream. Must be greater than 0 and less than 256.~~

	~~{{Prototype property\|particle_spawn_timeout\|[[Types/uint16\|uint16]]\|4 * <code>particle_spawn_interval</code>\|optional=true}}~~

	~~{{Prototype property\|particle_start_alpha\|[[Types/float\|float]]\|1\|optional=true}}~~

	~~{{Prototype property\|particle_end_alpha\|[[Types/float\|float]]\|1\|optional=true}}~~

	~~{{Prototype property\|particle_start_scale\|[[Types/float\|float]]\|1\|optional=true}}~~

	~~{{Prototype property\|particle_alpha_per_part\|[[Types/float\|float]]\|1\|optional=true}}~~

	~~{{Prototype property\|particle_scale_per_part\|[[Types/float\|float]]\|1\|optional=true}}~~

	~~{{Prototype property\|particle_fade_out_threshold\|[[Types/float\|float]]\|1\|optional=true}}~~
	~~Value between 0 and 1.~~

	~~{{Prototype property\|particle_loop_exit_threshold\|[[Types/float\|float]]\|0\|optional=true}}~~
	~~Value between 0 and 1.~~

	~~{{Prototype property\|particle_loop_frame_count\|[[Types/uint16\|uint16]]\|1\|optional=true}}~~
	~~Will be set to 1 by the game if less than 1.~~

	~~{{Prototype property\|particle_fade_out_duration\|[[Types/uint16\|uint16]]\|max uint16 (65553)\|optional=true}}~~
	~~Will be set to 1 by the game if less than 1.~~

	~~{{Prototype property\|spine_animation\|[[Types/Animation\|Animation]]\|optional=true}}~~

	~~{{Prototype property\|particle\|[[Types/Animation\|Animation]]\|optional=true}}~~

	~~{{Prototype property\|shadow\|[[Types/Animation\|Animation]]\|optional=true}}~~

	~~{{Prototype property\|smoke_sources\|[[Types/table\|table]] of [[Types/SmokeSource\|SmokeSource]]\|optional=true}}~~
	~~Smoke spawning is controlled by <code>progress_to_create_smoke</code>.~~

	~~{{Prototype property\|progress_to_create_smoke\|[[Types/float\|float]]\|0.5\|optional=true}}~~
	~~The point in the particles projectile arc to start spawning smoke. 0.5 (the default) starts spawning smoke at the halfway point between the source and target.~~

	~~{{Prototype property\|stream_light\|[[Types/LightDefinition\|LightDefinition]]\|optional=true}}~~

	~~{{Prototype property\|ground_light\|[[Types/LightDefinition\|LightDefinition]]\|optional=true}}~~

	~~{{Prototype property\|target_position_deviation\|[[Types/double\|double]]\|0\|optional=true}}~~

	~~{{Prototype property\|oriented_particle\|[[Types/bool\|bool]]\|false\|optional=true}}~~

	~~{{Prototype property\|shadow_scale_enabled\|[[Types/bool\|bool]]\|false\|optional=true}}~~

← Older revision		Revision as of 22:47, 29 September 2022
Line 20:		Line 20:

	{{Prototype property\|initial_action\|[[Types/Trigger\|Trigger]]\|optional=true}}		{{Prototype property\|initial_action\|[[Types/Trigger\|Trigger]]\|optional=true}}
			Action that is triggered when the first particle lands

	{{Prototype property\|action\|[[Types/Trigger\|Trigger]]\|optional=true}}		{{Prototype property\|action\|[[Types/Trigger\|Trigger]]\|optional=true}}
			Action that is triggered every time a particle lands

	{{Prototype property\|special_neutral_target_damage\|[[Types/DamagePrototype\|DamagePrototype]]\|optional=true}}		{{Prototype property\|special_neutral_target_damage\|[[Types/DamagePrototype\|DamagePrototype]]\|optional=true}}
Line 61:		Line 63:

	{{Prototype property\|smoke_sources\|[[Types/table\|table]] of [[Types/SmokeSource\|SmokeSource]]\|optional=true}}		{{Prototype property\|smoke_sources\|[[Types/table\|table]] of [[Types/SmokeSource\|SmokeSource]]\|optional=true}}
			Smoke spawning is controlled by progress_to_create_smoke

	{{Prototype property\|progress_to_create_smoke\|[[Types/float\|float]]\|0.5\|optional=true}}		{{Prototype property\|progress_to_create_smoke\|[[Types/float\|float]]\|0.5\|optional=true}}
			The point in the particles projectile arc to start spawning smoke. 0.5 (the default) starts spawning smoke at the halfway point between the source and target.

	{{Prototype property\|stream_light\|[[Types/LightDefinition\|LightDefinition]]\|optional=true}}		{{Prototype property\|stream_light\|[[Types/LightDefinition\|LightDefinition]]\|optional=true}}

← Older revision		Revision as of 11:31, 7 November 2022
Line 8:		Line 8:

	{{Prototype property\|particle_spawn_interval\|[[Types/uint16\|uint16]]}}		{{Prototype property\|particle_spawn_interval\|[[Types/uint16\|uint16]]}}
	The stream will spawn one particle every particle_spawn_interval ticks until the particle_spawn_timeout is reached. The first particle will trigger an initial_action upon landing. Each particle triggers an action upon landing. Particles spawned within a single particle_spawn_timeout interval will be connected by a stretched spine_animation.		The stream will spawn one particle every <code>particle_spawn_interval</code> ticks until the <code>particle_spawn_timeout</code> is reached. The first particle will trigger an <code>initial_action</code> upon landing. Each particle triggers an <code>action</code> upon landing. Particles spawned within a single <code>particle_spawn_timeout</code> interval will be connected by a stretched <code>spine_animation</code>.

	{{Prototype property\|particle_horizontal_speed\|[[Types/double\|double]]}}		{{Prototype property\|particle_horizontal_speed\|[[Types/double\|double]]}}
	Must be larger than 0. particle_horizontal_speed has to be greater than particle_horizontal_speed_deviation.		Must be larger than 0. <code>particle_horizontal_speed</code> has to be greater than <code>particle_horizontal_speed_deviation</code>.

	{{Prototype property\|particle_horizontal_speed_deviation\|[[Types/double\|double]]}}		{{Prototype property\|particle_horizontal_speed_deviation\|[[Types/double\|double]]}}
Line 20:		Line 20:

	{{Prototype property\|initial_action\|[[Types/Trigger\|Trigger]]\|optional=true}}		{{Prototype property\|initial_action\|[[Types/Trigger\|Trigger]]\|optional=true}}
	Action that is triggered when the first particle lands		Action that is triggered when the first particle lands.

	{{Prototype property\|action\|[[Types/Trigger\|Trigger]]\|optional=true}}		{{Prototype property\|action\|[[Types/Trigger\|Trigger]]\|optional=true}}
	Action that is triggered every time a particle lands		Action that is triggered every time a particle lands.

	{{Prototype property\|special_neutral_target_damage\|[[Types/DamagePrototype\|DamagePrototype]]\|optional=true}}		{{Prototype property\|special_neutral_target_damage\|[[Types/DamagePrototype\|DamagePrototype]]\|optional=true}}
Line 63:		Line 63:

	{{Prototype property\|smoke_sources\|[[Types/table\|table]] of [[Types/SmokeSource\|SmokeSource]]\|optional=true}}		{{Prototype property\|smoke_sources\|[[Types/table\|table]] of [[Types/SmokeSource\|SmokeSource]]\|optional=true}}
	Smoke spawning is controlled by progress_to_create_smoke		Smoke spawning is controlled by <code>progress_to_create_smoke</code>.

	{{Prototype property\|progress_to_create_smoke\|[[Types/float\|float]]\|0.5\|optional=true}}		{{Prototype property\|progress_to_create_smoke\|[[Types/float\|float]]\|0.5\|optional=true}}