Types/StyleSpecification - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:35Z

Removed old prototype docs

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:42:38Z

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

2023-08-16T17:51:49Z

Protected "Types/StyleSpecification": 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:49Z

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/StyleSpecification.html https://lua-api.factorio.com/latest/types/StyleSpecification.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].



	A [[types/table\|table]], used as a value in [[Prototype/GuiStyle]], named by the key that is used there. Prototype/GuiStyle loads one of the extensions of this prototype, depending on the specified <code>type</code>.		A [[types/table\|table]], used as a value in [[Prototype/GuiStyle]], named by the key that is used there. Prototype/GuiStyle loads one of the extensions of this prototype, depending on the specified <code>type</code>.

Bilka: /* parent */ better info on how parent defaults and the exception work. thanks therenas

2022-09-21T16:14:16Z

parent: better info on how parent defaults and the exception work. thanks therenas

← Older revision		Revision as of 16:14, 21 September 2022
Line 49:		Line 49:

	Name of a [[Types/StyleSpecification]]. This style specification inherits all property values from the parent style specification.<br>		Name of a [[Types/StyleSpecification]]. This style specification inherits all property values from the parent style specification.<br>
	~~It is recommended~~ to ~~always set~~ the ~~parent~~ style to ~~at least~~ the ~~basic vanilla style. If no~~ parent is set, some style properties ~~become~~ mandatory and behavior may be unexpected, such as an element not showing up because its size defaults to 0.		Styles without a parent property default to the root style for their type. The exception to this are the root styles themselves, they cannot have a parent set. Due to this, for root styles some style properties are mandatory and behavior may be unexpected, such as an element not showing up because its size defaults to 0.

	=== horizontal_align ===		=== horizontal_align ===

Bilka: /* effect */ Description

2022-04-29T13:50:06Z

effect: Description

← Older revision		Revision as of 13:50, 29 April 2022
Line 205:		Line 205:
	=== effect ===		=== effect ===
	'''Type''': [[Types/string\|string]]		'''Type''': [[Types/string\|string]]

			Name of a custom GUI effect. Custom GUI effects are hardcoded in the game's C++ code. List of available effects: "compilatron-hologram"

	=== effect_opacity ===		=== effect_opacity ===

DaveMcW: Add tooltip property

2021-06-18T02:03:42Z

Add tooltip property

← Older revision		Revision as of 02:03, 18 June 2021
Line 210:		Line 210:

	'''Default''': 1.0		'''Default''': 1.0

			=== tooltip ===
			'''Type''': [[Types/LocalisedString\|LocalisedString]]

	== Example ==		== Example ==

Bilka: StretchRule as separate type

2021-04-20T11:14:26Z

StretchRule as separate type

← Older revision		Revision as of 11:14, 20 April 2021
Line 72:		Line 72:

	=== horizontally_stretchable ===		=== horizontally_stretchable ===
	'''Type''': [[Types/~~string~~\|~~string~~]]		'''Type''': [[Types/StretchRule\|StretchRule]]

	'''Default''': "auto"		'''Default''': "auto"

	~~Either "off", "on", "auto" or "stretch_and_expand".~~

	=== vertically_stretchable ===		=== vertically_stretchable ===
	'''Type''': [[Types/~~string~~\|~~string~~]]		'''Type''': [[Types/StretchRule\|StretchRule]]

	'''Default''': "auto"		'''Default''': "auto"

	~~Either "off", "on", "auto" or "stretch_and_expand".~~

	=== horizontally_squashable ===		=== horizontally_squashable ===
	'''Type''': [[Types/~~string~~\|~~string~~]]		'''Type''': [[Types/StretchRule\|StretchRule]]

	'''Default''': "auto"		'''Default''': "auto"

	~~Either "off", "on", "auto" or "stretch_and_expand".~~

	=== vertically_squashable ===		=== vertically_squashable ===
	'''Type''': [[Types/~~string~~\|~~string~~]]		'''Type''': [[Types/StretchRule\|StretchRule]]

	'''Default''': "auto"		'''Default''': "auto"

	~~Either "off", "on", "auto" or "stretch_and_expand".~~

	=== natural_size ===		=== natural_size ===

Bilka: Added an example of adding a custom style

2021-03-11T17:38:52Z

Added an example of adding a custom style

← Older revision		Revision as of 17:38, 11 March 2021
Line 218:		Line 218:

	'''Default''': 1.0		'''Default''': 1.0

			== Example ==
			Example of adding a custom style via [[Prototype/GuiStyle]], in this case a [[Types/FrameStyleSpecification]]:
			<syntaxhighlight lang="lua">data.raw["gui-style"]["default"]["custom_style_for_a_frame"] =
			{
			type = "frame_style",
			parent = "frame",
			use_header_filler = false,
			drag_by_title = false
			}</syntaxhighlight>

Bilka: 1.1: added natrual_size, never_hide_by_search, ignored_by_search

2021-02-12T10:29:59Z

1.1: added natrual_size, never_hide_by_search, ignored_by_search

← Older revision		Revision as of 10:29, 12 February 2021
Line 64:		Line 64:

	Either "top", "center" or "bottom".		Either "top", "center" or "bottom".

			=== ignored_by_search ===
			'''Type''': [[Types/bool\|bool]]

			=== never_hide_by_search ===
			'''Type''': [[Types/bool\|bool]]

	=== horizontally_stretchable ===		=== horizontally_stretchable ===
Line 92:		Line 98:

	Either "off", "on", "auto" or "stretch_and_expand".		Either "off", "on", "auto" or "stretch_and_expand".

			=== natural_size ===
			'''Type''': [[Types/uint32\|uint32]] or [[Types/table\|table]] of [[Types/uint32\|uint32]]

			If this is an array, the first member of the array is <code>natural_width</code> and the second is <code>natural_height</code>. Otherwise the size is both <code>natural_width</code> and <code>natural_height</code>.

	=== size ===		=== size ===