Prototype/Beam - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:44Z

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 as a laser beam.~~

	~~{{Prototype TOC\|beam}}~~

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

	~~All animations must have the same number of frames: Tail must have same number of frames as start, ending, head, body, start_light, ending_light, head_light, tail_light and body_light.~~

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

	~~{{Prototype property\|damage_interval\|[[Types/uint32\|uint32]]}}~~
	~~Damage interval can't be 0. A value of 1 will cause the attack to be applied each tick.~~

	~~{{Prototype property\|head\|[[Types/Animation\|Animation]]}}~~
	~~Head segment of the beam.~~

	~~{{Prototype property\|tail\|[[Types/Animation\|Animation]]}}~~
	~~Tail segment of the beam.~~

	~~{{Prototype property\|body\|[[Types/AnimationVariations\|AnimationVariations]]}}~~
	~~Body segment of the beam. Must have at least 1 variation.~~

	~~== Optional properties ==~~

	~~{{Prototype property\|action\|[[Types/Trigger\|Trigger]]\|optional=true}}~~

	~~{{Prototype property\|target_offset\|[[Types/vector\|vector]]\|optional=true}}~~

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

	~~{{Prototype property\|action_triggered_automatically\|[[Types/bool\|bool]]\|false\|optional=true}}~~
	~~Whether this beams should trigger its action every damage_interval. If false, the action is instead triggered when its owner triggers shooting.~~

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

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

	~~{{Prototype property\|start\|[[Types/Animation\|Animation]]\|optional=true}}~~
	~~Start point of the beam.~~

	~~{{Prototype property\|ending\|[[Types/Animation\|Animation]]\|optional=true}}~~
	~~End point of the beam.~~

	~~{{Prototype property\|light_animations\|[[Types/table\|table]]\|optional=true}}~~
	~~Lights are additively accumulated onto lightmap, which is multiplicatively rendered on the game world.[https://forums.factorio.com/viewtopic.php?p=435042#p435042]~~

	~~Table with the following members:~~
	* start - [[Types/Animation\|Animation]] - Optional.
	* ending - [[Types/Animation\|Animation]] - Optional.
	* head - [[Types/Animation\|Animation]] - Optional.
	* tail - [[Types/Animation\|Animation]] - Optional.
	* body - [[Types/AnimationVariations\|AnimationVariations]] - Optional.

	~~{{Prototype property\|ground_light_animations\|[[Types/table\|table]]\|optional=true}}~~
	~~Table with the following members:~~
	* start - [[Types/Animation\|Animation]] - Optional.
	* ending - [[Types/Animation\|Animation]] - Optional.
	* head - [[Types/Animation\|Animation]] - Optional.
	* tail - [[Types/Animation\|Animation]] - Optional.
	* body - [[Types/AnimationVariations\|AnimationVariations]] - Optional.

	~~{{Prototype property\|start_light\|[[Types/Animation\|Animation]]\|optional=true}}~~
	~~This and the below properties ending in "_light" are considered deprecated. If they are present, then <code>light_animations</code> and <code>ground_light_animations</code> are not loaded.~~

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

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

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

	~~{{Prototype property\|body_light\|[[Types/AnimationVariations\|AnimationVariations]]\|optional=true}}~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:42:49Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:42, 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/BeamPrototype.html https://lua-api.factorio.com/latest/prototypes/BeamPrototype.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/BeamPrototype.html https://lua-api.factorio.com/latest/prototypes/BeamPrototype.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/Beam": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:52:04Z

Protected "Prototype/Beam": 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:04Z

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/BeamPrototype.html https://lua-api.factorio.com/latest/prototypes/BeamPrototype.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 as a laser beam.		Used as a laser beam.

Bilka: Converted to SMW format

2019-07-29T20:14:23Z

Converted to SMW format

Show changes

Bilka: /* Optional properties */ action_triggered_automatically — 0.17.59

2019-07-26T12:26:26Z

Optional properties: action_triggered_automatically — 0.17.59

← Older revision		Revision as of 12:26, 26 July 2019
Line 46:		Line 46:

	'''Default''': false		'''Default''': false

			=== action_triggered_automatically ===
			'''Type''': [[Types/bool]]

			'''Default''': false

			Whether this beams should trigger its action every damage_interval. If false, the action is instead triggered when its owner triggers shooting.

	=== random_end_animation_rotation ===		=== random_end_animation_rotation ===

Bilka: 0.17.59

2019-07-26T12:14:34Z

0.17.59

@@ Line 66: / Line 66: @@
 End point of the beam.
 === start_light ===
 '''Type''': [[Types/Animation]]
-Lights are additively accumulated onto lightmap, which is multiplicatively rendered on the game world.[https://forums.factorio.com/viewtopic.php?p=435042#p435042]
+This and the below properties ending in "_light" are considered deprecated. If they are present, then <code>light_animations</code> and <code>ground_light_animations</code> are not loaded.
 === ending_light ===

Bilka: Set prototype parent

2019-07-24T15:17:04Z

Set prototype parent

← Older revision		Revision as of 15:17, 24 July 2019
Line 1:		Line 1:
			{{Prototype parent\|Prototype/Entity}}

	== Basics ==		== Basics ==
	Prototype type: '''beam'''		Prototype type: '''beam'''

Bilka: 0.17.47

2019-06-10T08:08:04Z

0.17.47

@@ Line 6: / Line 6: @@
 == Mandatory properties ==
 This prototype inherits all the properties from [[Prototype/Entity]].
 === width ===
@@ Line 17: / Line 19: @@
 === head ===
 '''Type''': [[Types/Animation]]
 === tail ===
 '''Type''': [[Types/Animation]]
 === body ===
 '''Type''': [[Types/AnimationVariations]]
-Must have at least 1 variation.
+Body segment of the beam. Must have at least 1 variation.
 == Optional properties ==
@@ Line 30: / Line 36: @@
 === action ===
 '''Type''': [[Types/Trigger]]
 === target_offset ===
@@ Line 54: / Line 54: @@
 '''Default''': true

Bilka: typo

2019-03-28T17:02:34Z

typo

← Older revision		Revision as of 17:02, 28 March 2019
Line 38:		Line 38:

	=== target_offset ===		=== target_offset ===
	'''Type''': [[Types/~~Vector~~]]		'''Type''': [[Types/vector]]

	=== random_target_offset ===		=== random_target_offset ===

← 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 as a laser beam.~~

	~~{{Prototype TOC\|beam}}~~

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

	~~All animations must have the same number of frames: Tail must have same number of frames as start, ending, head, body, start_light, ending_light, head_light, tail_light and body_light.~~

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

	~~{{Prototype property\|damage_interval\|[[Types/uint32\|uint32]]}}~~
	~~Damage interval can't be 0. A value of 1 will cause the attack to be applied each tick.~~

	~~{{Prototype property\|head\|[[Types/Animation\|Animation]]}}~~
	~~Head segment of the beam.~~

	~~{{Prototype property\|tail\|[[Types/Animation\|Animation]]}}~~
	~~Tail segment of the beam.~~

	~~{{Prototype property\|body\|[[Types/AnimationVariations\|AnimationVariations]]}}~~
	~~Body segment of the beam. Must have at least 1 variation.~~

	~~== Optional properties ==~~

	~~{{Prototype property\|action\|[[Types/Trigger\|Trigger]]\|optional=true}}~~

	~~{{Prototype property\|target_offset\|[[Types/vector\|vector]]\|optional=true}}~~

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

	~~{{Prototype property\|action_triggered_automatically\|[[Types/bool\|bool]]\|false\|optional=true}}~~
	~~Whether this beams should trigger its action every damage_interval. If false, the action is instead triggered when its owner triggers shooting.~~

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

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

	~~{{Prototype property\|start\|[[Types/Animation\|Animation]]\|optional=true}}~~
	~~Start point of the beam.~~

	~~{{Prototype property\|ending\|[[Types/Animation\|Animation]]\|optional=true}}~~
	~~End point of the beam.~~

	~~{{Prototype property\|light_animations\|[[Types/table\|table]]\|optional=true}}~~
	~~Lights are additively accumulated onto lightmap, which is multiplicatively rendered on the game world.[https://forums.factorio.com/viewtopic.php?p=435042#p435042]~~

	~~Table with the following members:~~
	* start - [[Types/Animation\|Animation]] - Optional.
	* ending - [[Types/Animation\|Animation]] - Optional.
	* head - [[Types/Animation\|Animation]] - Optional.
	* tail - [[Types/Animation\|Animation]] - Optional.
	* body - [[Types/AnimationVariations\|AnimationVariations]] - Optional.

	~~{{Prototype property\|ground_light_animations\|[[Types/table\|table]]\|optional=true}}~~
	~~Table with the following members:~~
	* start - [[Types/Animation\|Animation]] - Optional.
	* ending - [[Types/Animation\|Animation]] - Optional.
	* head - [[Types/Animation\|Animation]] - Optional.
	* tail - [[Types/Animation\|Animation]] - Optional.
	* body - [[Types/AnimationVariations\|AnimationVariations]] - Optional.

	~~{{Prototype property\|start_light\|[[Types/Animation\|Animation]]\|optional=true}}~~
	~~This and the below properties ending in "_light" are considered deprecated. If they are present, then <code>light_animations</code> and <code>ground_light_animations</code> are not loaded.~~

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

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

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

	~~{{Prototype property\|body_light\|[[Types/AnimationVariations\|AnimationVariations]]\|optional=true}}~~