Types/SpriteFlags: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(so more info)
(Updated styling of prototype doc migration note)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<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/SpriteFlags.html https://lua-api.factorio.com/latest/types/SpriteFlags.html]
</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>
Array ([[Types/table]]) of strings. The possible strings are listed below.
Array ([[Types/table]]) of strings. The possible strings are listed below.


Line 21: Line 27:


== "mask" ==
== "mask" ==
 
When this flag is set, it will internally set these flags:
* "group=none"


== "icon" ==
== "icon" ==
When this flag is set, it will automatically set these flags:
When this flag is set, it will internally set these flags:
* "no-crop"
* "no-crop"
* "no-scale"
* "mipmap"
* "linear-minification"
* "linear-magnification"
* "linear-mip-level"
* "not-compressed"
* "not-compressed"
* "group=icon"
== "gui" ==
When this flag is set, it will internally set these flags:
* "no-crop"
* "no-scale"
* "mipmap"
* "mipmap"
* "linear-minification"
* "linear-minification"
* "linear-magnification"
* "linear-magnification"
* "linear-mip-level"
* "linear-mip-level"
* "no-scale"
* "not-compressed"
* "group=gui"


== "light" ==
== "gui-icon" ==
When this flag is set, it will automatically set these flags:
When this flag is set, it will internally set these flags:
* "no-crop"
* "no-crop"
* "no-scale"
* "no-scale"
Line 40: Line 59:
* "linear-minification"
* "linear-minification"
* "linear-magnification"
* "linear-magnification"
* "not-compressed"
* "group=icon"
== "light" ==
When this flag is set, it will internally set these flags:
* "mipmap"
* "linear-mip-level"
* "linear-mip-level"
* "linear-minification"
* "linear-magnification"
* "group=none"


== "terrain" ==
== "terrain" ==
When this flag is set, it will automatically set these flags:
When this flag is set, it will internally set these flags:
* "mipmap"
* "linear-mip-level"
* "linear-minification"
* "no-crop"
* "no-crop"
* "group=terrain"
== "terrain-effect-map" ==
When this flag is set, it will internally set these flags:
* "mipmap"
* "mipmap"
* "linear-mip-level"
* "linear-minification"
* "linear-minification"
* "linear-mip-level"
* "no-crop"
* "terrain-effect-map" (internal group flag)


== "shadow" ==
== "shadow" ==


== "smoke" ==
== "smoke" ==
When this flag is set, it will internally set these flags:
* "mipmap"
* "linear-minification"
* "linear-magnification"
* "group=smoke"


== "decal" ==
== "decal" ==
When this flag is set, it will internally set these flags:
* "group=decal"


== "low-object" ==
== "low-object" ==


== "trilinear-filtering" ==
== "trilinear-filtering" ==
== "group=none" ==
== "group=terrain" ==
== "group=shadow" ==
== "group=smoke" ==
== "group=decal" ==
== "group=low-object" ==
== "group=gui" ==
== "group=icon" ==
== "group=icon-background" ==


== "compressed" ==
== "compressed" ==
Line 63: Line 125:


== Example ==
== Example ==
     flags = {"icon", "no-crop"}
     flags = { "linear-minification", "linear-magnification" }

Latest revision as of 10:42, 21 September 2023

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/SpriteFlags.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 on the forums.


Array (Types/table) of strings. The possible strings are listed below.

"no-crop"

The sprite won't be automatically cropped.

"not-compressed"

"always-compressed"

"mipmap"

"linear-minification"

"linear-magnification"

"linear-mip-level"

"alpha-mask"

"no-scale"

"mask"

When this flag is set, it will internally set these flags:

  • "group=none"

"icon"

When this flag is set, it will internally set these flags:

  • "no-crop"
  • "no-scale"
  • "mipmap"
  • "linear-minification"
  • "linear-magnification"
  • "linear-mip-level"
  • "not-compressed"
  • "group=icon"

"gui"

When this flag is set, it will internally set these flags:

  • "no-crop"
  • "no-scale"
  • "mipmap"
  • "linear-minification"
  • "linear-magnification"
  • "linear-mip-level"
  • "not-compressed"
  • "group=gui"

"gui-icon"

When this flag is set, it will internally set these flags:

  • "no-crop"
  • "no-scale"
  • "mipmap"
  • "linear-minification"
  • "linear-magnification"
  • "not-compressed"
  • "group=icon"

"light"

When this flag is set, it will internally set these flags:

  • "mipmap"
  • "linear-mip-level"
  • "linear-minification"
  • "linear-magnification"
  • "group=none"

"terrain"

When this flag is set, it will internally set these flags:

  • "mipmap"
  • "linear-mip-level"
  • "linear-minification"
  • "no-crop"
  • "group=terrain"

"terrain-effect-map"

When this flag is set, it will internally set these flags:

  • "mipmap"
  • "linear-mip-level"
  • "linear-minification"
  • "no-crop"
  • "terrain-effect-map" (internal group flag)

"shadow"

"smoke"

When this flag is set, it will internally set these flags:

  • "mipmap"
  • "linear-minification"
  • "linear-magnification"
  • "group=smoke"

"decal"

When this flag is set, it will internally set these flags:

  • "group=decal"

"low-object"

"trilinear-filtering"

"group=none"

"group=terrain"

"group=shadow"

"group=smoke"

"group=decal"

"group=low-object"

"group=gui"

"group=icon"

"group=icon-background"

"compressed"

Deprecated flag that does nothing but is kept to prevent "unknown sprite flag" errors.

Example

   flags = { "linear-minification", "linear-magnification" }