Types/LightDefinition - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:27Z

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>



	~~Either a table with the properties listed below or an [[Types/table\|array]] of tables with the below properties. Specifies a light source.~~

	~~== Mandatory properties ==~~
	~~=== type ===~~
	~~'''Type''': [[Types/string]]~~

	~~'''Default''': "basic"~~

	~~Either "basic" or "oriented". If the type is "oriented", the following properties are read additionally to the other properties:~~

	* picture - [[Types/Sprite]], mandatory
	* rotation_shift - [[Types/RealOrientation]], optional

	~~=== intensity ===~~
	~~'''Type''': [[Types/float]]~~

	~~Brightness of the light in the range [0, 1] where 0 is no light and 1 is the maximum light.~~
	~~<syntaxhighlight lang="lua">intensity = 0.5</syntaxhighlight>~~
	~~=== size ===~~
	~~'''Type''': [[Types/float]]~~

	~~The radius of the light in tiles.~~
	~~Note, that the light gets darker near the edges, so the effective size of the light seems to be smaller.~~
	~~<syntaxhighlight lang="lua">size = 15 -- big light source</syntaxhighlight>~~

	~~== Optional properties ==~~

	~~=== source_orientation_offset ===~~
	~~'''Type''': [[Types/RealOrientation]]~~

	~~'''Default''': 0~~

	~~=== add_perspective ===~~
	~~'''Type''': [[Types/bool]]~~

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

	~~=== shift ===~~
	~~'''Type''': [[Types/vector]]~~

	~~=== color ===~~
	~~'''Type''': [[Types/Color]]~~

	~~'''Default''': Light has no color~~

	~~Color of the light.~~

	~~=== minimum_darkness ===~~
	~~'''Type''': [[Types/float]]~~

	~~'''Default''': 0~~

	~~== Example ==~~
	~~The light of the orange state of the rail signal.~~
	~~<syntaxhighlight lang="lua">orange_light = {intensity = 0.2, size = 4, color={r=1, g=0.5}}</syntaxhighlight>~~

	~~The front lights of the car:~~
	~~<syntaxhighlight lang="lua">light =~~
	{
	{
	~~type = "oriented",~~
	~~minimum_darkness = 0.3,~~
	~~picture =~~
	{
	~~filename = "__core__/graphics/light-cone.png",~~
	~~priority = "extra-high",~~
	~~flags = { "light" },~~
	~~scale = 2,~~
	~~width = 200,~~
	~~height = 200~~
	},
	~~shift = {-0.6, -14},~~
	~~size = 2,~~
	~~intensity = 0.6,~~
	~~color = {r = 0.92, g = 0.77, b = 0.3}~~
	},
	{
	~~type = "oriented",~~
	~~minimum_darkness = 0.3,~~
	~~picture =~~
	{
	~~filename = "__core__/graphics/light-cone.png",~~
	~~priority = "extra-high",~~
	~~flags = { "light" },~~
	~~scale = 2,~~
	~~width = 200,~~
	~~height = 200~~
	},
	~~shift = {0.6, -14},~~
	~~size = 2,~~
	~~intensity = 0.6,~~
	~~color = {r = 0.92, g = 0.77, b = 0.3}~~
	}
	~~}</syntaxhighlight>~~

	~~{{Prototype property type usage\|{{FULLPAGENAME}}}}~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:42:31Z

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/types/LightDefinition.html https://lua-api.factorio.com/latest/types/LightDefinition.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/types/LightDefinition.html https://lua-api.factorio.com/latest/types/LightDefinition.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 "Types/LightDefinition": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:51:40Z

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

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

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:51:40Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:51, 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/types/LightDefinition.html https://lua-api.factorio.com/latest/types/LightDefinition.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].



	Either a table with the properties listed below or an [[Types/table\|array]] of tables with the below properties. Specifies a light source.		Either a table with the properties listed below or an [[Types/table\|array]] of tables with the below properties. Specifies a light source.

Bilka: can be an array of LightDefinition

2022-03-24T17:17:23Z

can be an array of LightDefinition

@@ Line 1: / Line 1: @@
-== Basics ==
+Either a table with the properties listed below or an [[Types/table|array]] of tables with the below properties. Specifies a light source.
 == Mandatory properties ==
@@ Line 55: / Line 54: @@
 The light of the orange state of the rail signal.
 <syntaxhighlight lang="lua">orange_light = {intensity = 0.2, size = 4, color={r=1, g=0.5}}</syntaxhighlight>
 {{Prototype property type usage|{{FULLPAGENAME}}}}

Bilka: 1.0.0: added source_orientation_offset

2020-09-08T11:32:47Z

1.0.0: added source_orientation_offset

← Older revision		Revision as of 11:32, 8 September 2020
Line 27:		Line 27:
	== Optional properties ==		== Optional properties ==

	=== ~~color~~ ===		=== source_orientation_offset ===
	'''Type''': [[Types/~~Color~~]]		'''Type''': [[Types/RealOrientation]]

	~~'''Default''': Light has no color~~

	~~Color of the light.~~		'''Default''': 0

	=== add_perspective ===		=== add_perspective ===
Line 41:		Line 39:
	=== shift ===		=== shift ===
	'''Type''': [[Types/vector]]		'''Type''': [[Types/vector]]

			=== color ===
			'''Type''': [[Types/Color]]

			'''Default''': Light has no color

			Color of the light.

	=== minimum_darkness ===		=== minimum_darkness ===

Bilka: property usage

2020-08-06T05:46:51Z

property usage

← Older revision		Revision as of 05:46, 6 August 2020
Line 50:		Line 50:
	The light of the orange state of the rail signal.		The light of the orange state of the rail signal.
	<syntaxhighlight lang="lua">orange_light = {intensity = 0.2, size = 4, color={r=1, g=0.5}}</syntaxhighlight>		<syntaxhighlight lang="lua">orange_light = {intensity = 0.2, size = 4, color={r=1, g=0.5}}</syntaxhighlight>

			{{Prototype property type usage\|{{FULLPAGENAME}}}}

Bilka: /* Mandatory properties */ 0.18.21

2020-04-29T15:11:25Z

Mandatory properties: 0.18.21

← Older revision		Revision as of 15:11, 29 April 2020
Line 11:		Line 11:

	* picture - [[Types/Sprite]], mandatory		* picture - [[Types/Sprite]], mandatory
	* rotation_shift - [[Types/~~float~~]], optional		* rotation_shift - [[Types/RealOrientation]], optional

	=== intensity ===		=== intensity ===

Bilka: fixed link

2018-09-22T10:56:02Z

fixed link

← Older revision		Revision as of 10:56, 22 September 2018
Line 28:		Line 28:

	=== color ===		=== color ===
	'''Type''': [[Types/~~color~~]]		'''Type''': [[Types/Color]]

	'''Default''': Light has no color		'''Default''': Light has no color

Bilka: added type info

2018-09-16T21:02:55Z

added type info

← Older revision		Revision as of 21:02, 16 September 2018
Line 2:		Line 2:
	Specifies the light source		Specifies the light source

	== ~~Properties~~ ==		== Mandatory properties ==
			=== type ===
			'''Type''': [[Types/string]]

			'''Default''': "basic"

			Either "basic" or "oriented". If the type is "oriented", the following properties are read additionally to the other properties:

			* picture - [[Types/Sprite]], mandatory
			* rotation_shift - [[Types/float]], optional

	=== intensity ===		=== intensity ===
	'''Type''': [[Types/float]]		'''Type''': [[Types/float]]
Line 14:		Line 24:
	Note, that the light gets darker near the edges, so the effective size of the light seems to be smaller.		Note, that the light gets darker near the edges, so the effective size of the light seems to be smaller.
	<syntaxhighlight lang="lua">size = 15 -- big light source</syntaxhighlight>		<syntaxhighlight lang="lua">size = 15 -- big light source</syntaxhighlight>

			== Optional properties ==

	=== color ===		=== color ===
	'''Type''': [[Types/color]]		'''Type''': [[Types/color]]