Graphical asset modding - 版本历史

2025年1月7日 (二) 12:06 RenKo

2025-01-07T12:06:35Z

←上一版本		2025年1月7日 (二) 20:06的版本
第1行：		第1行：
	{{version\|1.5}}		{{version\|1.5}}
	{{需要翻译\|译者=霜泽图书馆}}		{{需要翻译\|译者=霜泽图书馆}}

	Graphical assets are image files that have been defined in a <code>.gfx</code> file. This binds the image to a script name that is then referred to in the <code>.gui</code> interface files.		Graphical assets are image files that have been defined in a <code>.gfx</code> file. This binds the image to a script name that is then referred to in the <code>.gui</code> interface files.

第133行：		第134行：
	textureFile1 = "<path>"		textureFile1 = "<path>"
	textureFile2 = "<path>"		textureFile2 = "<path>"
	color = { <r> <g> <b> }		color = { <r> <g> <b> [<a>] }
	colortwo = { <r> <g> <b> }		colortwo = { <r> <g> <b> [<a>] }
	size = {		size = {
	x = <int>		x = <int>
第149行：		第150行：
	'''textureFile1''' is the image to use for the progress bar.<br/>		'''textureFile1''' is the image to use for the progress bar.<br/>
	'''textureFile2''' is the image to use for the background of the progress bar.<br/>		'''textureFile2''' is the image to use for the background of the progress bar.<br/>
	'''color''' defines the unprogressed color of the bar. It is decimal ~~RGB~~.<br/>		'''color''' defines the unprogressed color of the bar. It is decimal RGBA. Alpha is optional.<br/>
	'''colortwo''' defines the progressed color of the bar. It is decimal ~~RGB~~.<br/>		'''colortwo''' defines the progressed color of the bar. It is decimal RGBA. Alpha is optional.<br/>
	'''size''' defines the size of the progress bar section in height and width.<br/>		'''size''' defines the size of the progress bar section in height and width.<br/>
	'''effectFile''' is used to define an effect state to apply to the image, i.e. the button press effect on a button image. Effects are found in {{path\|gfx/FX/*.lua}}. Multiple can be defined to add multiple effects.<br/>		'''effectFile''' is used to define an effect state to apply to the image, i.e. the button press effect on a button image. Effects are found in {{path\|gfx/FX/*.lua}}. Multiple can be defined to add multiple effects.<br/>

2024年9月21日 (六) 11:04 秋起.

2024-09-21T11:04:51Z

←上一版本		2024年9月21日 (六) 19:04的版本
第1行：		第1行：
	{{version\|1.5}}		{{version\|1.5}}
			{{需要翻译\|译者=霜泽图书馆}}
	Graphical assets are image files that have been defined in a <code>.gfx</code> file. This binds the image to a script name that is then referred to in the <code>.gui</code> interface files.		Graphical assets are image files that have been defined in a <code>.gfx</code> file. This binds the image to a script name that is then referred to in the <code>.gui</code> interface files.

第357行：		第357行：

	{{Modding navbox}}		{{Modding navbox}}
	[[~~Category~~:Modding]]		[[ 分类:Modding]]

2024年8月5日 (一) 05:46 Vmsz23

2024-08-05T05:46:24Z

←上一版本		2024年8月5日 (一) 13:46的版本
第25行：		第25行：
	allwaystransparent = <bool>		allwaystransparent = <bool>
	legacy_lazy_load = <bool>		legacy_lazy_load = <bool>
			transparencecheck = <bool>

	animation = {		animation = {
第59行：		第60行：
	'''effectFile''' is used to define an effect state to apply to the image, i.e. the button press effect on a button image. Effects are found in {{path\|gfx/FX/*.lua}}. Multiple can be defined to add multiple effects.		'''effectFile''' is used to define an effect state to apply to the image, i.e. the button press effect on a button image. Effects are found in {{path\|gfx/FX/*.lua}}. Multiple can be defined to add multiple effects.

	'''allwaystransparent''' defines whether ~~the~~ image ~~is bound by its alpha channel~~ with ~~regards to player clicks~~. ~~Otherwise the bounding box is~~ the image ~~dimensions~~.		'''allwaystransparent''' defines whether or not an image can be clicked on and interacted with. If yes, the image will have no tooltip and can not be clicked on when used in game.

	'''legacy_lazy_load''' defines whether the image is lazy loaded.		'''legacy_lazy_load''' defines whether the image is lazy loaded.

			'''transparencecheck''' defines whether the image is bound by its alpha channel with regards to player clicks. Otherwise the bounding box is the image dimensions.

	'''animation''' scope is used to add animation to an image. It uses the following attributes:		'''animation''' scope is used to add animation to an image. It uses the following attributes:
第75行：		第78行：
	* '''animationtexturescale''' controls the scale of the animation image.		* '''animationtexturescale''' controls the scale of the animation image.
	* '''animationframes''' sets the number of frames within the animation image.		* '''animationframes''' sets the number of frames within the animation image.

			Be wary that the maximum file size for a sprite .dds files is around 16MB

	== frameAnimatedSpriteType ==		== frameAnimatedSpriteType ==
第129行：		第134行：
	textureFile2 = "<path>"		textureFile2 = "<path>"
	color = { <r> <g> <b> }		color = { <r> <g> <b> }
	~~color2~~ = { <r> <g> <b> }		colortwo = { <r> <g> <b> }
	size = {		size = {
	x = <int>		x = <int>
第135行：		第140行：
	}		}
	effectFile = <path>		effectFile = <path>

	horizontal = <bool>		horizontal = <bool>
			steps = <int>
	}		}
	}		}
	</pre>		</pre>

	'''name''' is the name you have given to the asset. This may be prefixed with various other segments, such as ''idea'' for idea images, etc.		'''name''' is the name you have given to the asset. This may be prefixed with various other segments, such as ''idea'' for idea images, etc.<br/>
			'''textureFile1''' is the image to use for the progress bar.<br/>
	'''textureFile1''' is the image to use for the progress bar.		'''textureFile2''' is the image to use for the background of the progress bar.<br/>
			'''color''' defines the unprogressed color of the bar. It is decimal RGB.<br/>
	'''textureFile2''' is the image to use for the background of the progress bar.		'''colortwo''' defines the progressed color of the bar. It is decimal RGB.<br/>
			'''size''' defines the size of the progress bar section in height and width.<br/>
	'''color''' defines the unprogressed color of the bar. It is decimal RGB.		'''effectFile''' is used to define an effect state to apply to the image, i.e. the button press effect on a button image. Effects are found in {{path\|gfx/FX/*.lua}}. Multiple can be defined to add multiple effects.<br/>
			'''horizontal''' defines whether the progress bar is horizontal or not. By default a bar is horizontal.<br/>
	'''colortwo''' defines the progressed color of the bar. It is decimal RGB.		'''steps''' defines the precision of the progressbar or into how many frames it's split into. Defaults to 100 if unset.

	'''size''' defines the size of the progress bar section in height and width.

	'''effectFile''' is used to define an effect state to apply to the image, i.e. the button press effect on a button image. Effects are found in {{path\|gfx/FX/*.lua}}. Multiple can be defined to add multiple effects.

	'''horizontal''' defines whether the progress bar is horizontal or not. By default a bar is horizontal.

	== corneredTileSpriteType ==		== corneredTileSpriteType ==
第218行：		第217行：
	textureFile1 = <path>		textureFile1 = <path>
	textureFile2 = <path>		textureFile2 = <path>
	effectFile = <path		effectFile = <path>
	}		}
	}		}
第316行：		第315行：
	</pre>		</pre>

	'''name''' is the name of the font.		'''name''' is the reference name of the font for other graphics files.

	'''path''' is the path to the font. Fonts are found in {{path\|gfx/fonts/}}.		'''path''' is the path to the font. Fonts are found in {{path\|gfx/fonts/}}.

	'''color''' is the default color of the font. It is a ~~hexidecimal~~ RGB code.		'''color''' is the default color of the font. It is a hexadecimal RGB code.

	'''border_color''' is the border color of the font. It is a ~~hexidecimal~~ RGB code.		'''border_color''' is the border color of the font. It is a hexadecimal RGB code.

	'''fontfiles''' is used when ~~their~~ are multiple font images for one font, i.e. to support English and ~~Cryllic~~. This is used ~~inplace~~ of '''path'''.		'''fontfiles''' is used when there are multiple font images for one font, i.e. to support English and Cyrillic. This is used in place of '''path'''.

	'''textcolors''' alters the global textcolors for the font it is nested within.		'''textcolors''' alters the global textcolors for the font it is nested within.
第358行：		第357行：

	{{Modding navbox}}		{{Modding navbox}}
	[[ 分类:Modding]]		[[Category:Modding]]

Katty von Keksburg：文本替换 - 替换“[[Category:”为“[[分类:”

2022-12-05T07:34:16Z

文本替换 - 替换“[[Category:”为“[[分类:”

←上一版本		2022年12月5日 (一) 15:34的版本
第358行：		第358行：

	{{Modding navbox}}		{{Modding navbox}}
	[[~~Category~~:Modding]]		[[ 分类:Modding]]

Hstar：merge from offical wiki

2020-08-15T08:54:35Z

merge from offical wiki

新页面

{{version|1.5}}

Graphical assets are image files that have been defined in a <code>.gfx</code> file. This binds the image to a script name that is then referred to in the <code>.gui</code> interface files.

Graphical asset files can be found in {{path|interface/*.gfx}}.

Note that for many assets, such as technology and equipment asset definitions, the image can be specified for a specific tag, i.e. <code>GFX_ENG_<name></code>, which only displays the asset for the specified tag. This will override the base asset of the same name. This also applies to graphical culture, i.e. <code>GFX_african_<name></code>.

= Sprite Types =
{{SVersion|1.5}}

=== spriteType ===
{{SVersion|1.5}}

A '''spriteType''' and '''textSpriteType''' asset entry follows this format:

<pre>
spriteTypes = {
spriteType = {
name = "GFX_<name>"
texturefile = <path>
noOfFrames = <int>
effectFile = <path>

allwaystransparent = <bool>
legacy_lazy_load = <bool>

animation = {
animationmaskfile = <path>
animationtexturefile = <path>
animationrotation = <float>
animationlooping = <bool>
animationtime = <float>
animationdelay = <float>
animationblendmode = <mode>
animationtype = <type>
animationrotationoffset = {
x = <float>
y = <float>
}
animationtexturescale = {
x = <float>
y = <float>
}
animationframes = {
<int> <int> # etc
}
}
}
}
</pre>

'''name''' is the name you have given to the asset. This may be prefixed with various other segments, such as ''idea'' for idea images, etc.

'''texturefile''' is the path to the image, based of the {{path|}}, meaning you only include the folders within this folder, not the full filepath.

'''noOfFrames''' is used for images with multiple ''frames'' within, for example <code>GFX_unit_level</code> has five images within for each of the unit level images, and so would have <code>noOfFrames = 5</code> set within its asset definition.

'''effectFile''' is used to define an effect state to apply to the image, i.e. the button press effect on a button image. Effects are found in {{path|gfx/FX/*.lua}}. Multiple can be defined to add multiple effects.

'''allwaystransparent''' defines whether the image is bound by its alpha channel with regards to player clicks. Otherwise the bounding box is the image dimensions.

'''legacy_lazy_load''' defines whether the image is lazy loaded.

'''animation''' scope is used to add animation to an image. It uses the following attributes:
* '''animationmaskfile''' controls the mask image for the animation.
* '''animationtexturefile''' controls the color image used for the animation.
* '''animationrotation''' controls the rotation of the animation image. By default it is -90 clockwise.
* '''animationlooping''' controls whether the animation loops.
* '''animationtime''' controls the duration of the animation. It is measured in seconds.
* '''animationdelay''' controls the delay between animation loops. It is measured in seconds.
* '''animationblendmode''' controls the blend mode for the animation image. Can be ''add'', ''multiply'' or ''overlay''.
* '''animationtype''' controls the type of animation. Can be ''scrolling'', ''rotating'' or ''pulsing''.
* '''animationrotationoffset''' controls the ''x'' and ''y'' offsets for the rotation.
* '''animationtexturescale''' controls the scale of the animation image.
* '''animationframes''' sets the number of frames within the animation image.

== frameAnimatedSpriteType ==
{{SVersion|1.5}}

A '''frameAnimatedSpriteType''' asset entry follows this format:

<pre>
spriteTypes = {
frameAnimatedSpriteType = {
name = "GFX_<name>"
texturefile = "<path>"
noOfFrames = <int>
effectFile = "<path>"

animation_rate_fps = <int>
looping = <bool>
play_on_show = <bool>
pause_on_loop = <float>

allwaystransparent = <bool>
}
}
</pre>

'''name''' is the name you have given to the asset. This may be prefixed with various other segments, such as ''idea'' for idea images, etc.

'''texturefile''' is the path to the image, based of the {{path|}}, meaning you only include the folders within this folder, not the full filepath.

'''noOfFrames''' is used for images with multiple ''frames'' within, for example <code>GFX_unit_level</code> has five images within for each of the unit level images, and so would have <code>noOfFrames = 5</code> set within its asset definition.

'''effectFile''' is used to define an effect state to apply to the image, i.e. the button press effect on a button image. Effects are found in {{path|gfx/FX/*.lua}}. Multiple can be defined to add multiple effects.

'''animation_rate_fps''' is the rate at which the animation plays.

'''looping''' defines whether the animation loops.

'''play_on_show''' defines whether the animations starts playing when visible.

'''pause_on_loop''' defines the length of time to pause for after an animation loop.

'''allwaystransparent''' defines whether the image is bound by its alpha channel with regards to player clicks. Otherwise the bounding box is the image dimensions.

== progressbartype ==
{{SVersion|1.5}}

A '''progressbartype''' asset entry is used for progress bars. It follows this format:

<pre>
spriteTypes = {
progressbartype = {
name = "GFX_<name>"
textureFile1 = "<path>"
textureFile2 = "<path>"
color = { <r> <g> }
color2 = { <r> <g> }
size = {
x = <int>
y = <int>
}
effectFile = <path>

horizontal = <bool>
}
}
</pre>

'''name''' is the name you have given to the asset. This may be prefixed with various other segments, such as ''idea'' for idea images, etc.

'''textureFile1''' is the image to use for the progress bar.

'''textureFile2''' is the image to use for the background of the progress bar.

'''color''' defines the unprogressed color of the bar. It is decimal RGB.

'''colortwo''' defines the progressed color of the bar. It is decimal RGB.

'''size''' defines the size of the progress bar section in height and width.

'''effectFile''' is used to define an effect state to apply to the image, i.e. the button press effect on a button image. Effects are found in {{path|gfx/FX/*.lua}}. Multiple can be defined to add multiple effects.

'''horizontal''' defines whether the progress bar is horizontal or not. By default a bar is horizontal.

== corneredTileSpriteType ==
{{SVersion|1.5}}

A '''corneredTileSpriteType''' asset entry is used for tiling textures that tile to fill the size of the interface element they are used in. It follows this format:

<pre>
spriteTypes = {
corneredTileSpriteType = {
name = "GFX_<name>"
texturefile = "<path>"
noOfFrames = <int>
size = {
x = <int>
y = <int>
}
borderSize = {
x = <int>
y = <int>
}
effectFile = <path>

allwaystransparent = <bool>
tilingCenter = <bool>

looping = <bool>
animation_rate_spf = <int>
}
}
</pre>

'''name''' is the name you have given to the asset. This may be prefixed with various other segments, such as ''idea'' for idea images, etc.

'''texturefile''' is the path to the image, based of the {{path|}}, meaning you only include the folders within this folder, not the full filepath.

'''noOfFrames''' is used for images with multiple ''frames'' within, for example <code>GFX_unit_level</code> has five images within for each of the unit level images, and so would have <code>noOfFrames = 5</code> set within its asset definition.

'''size''' determines the size of the tile.

'''borderSize''' determines the size of the border.

'''effectFile''' is used to define an effect state to apply to the image, i.e. the button press effect on a button image. Effects are found in {{path|gfx/FX/*.lua}}. Multiple can be defined to add multiple effects.

'''allwaystransparent''' defines whether the image is bound by its alpha channel with regards to player clicks. Otherwise the bounding box is the image dimensions.

'''tilingCenter''' defines whether the center of the image is used for tiling, rather than the top left corner.

'''looping''' defines whether the animation loops.

'''animation_rate_spf''' defiens the framerate at which the animation plays.

== maskedShieldType ==
{{SVersion|1.5}}

A '''maskedShieldType''' asset entry is used for country shields. It follows this format:

<pre>
spriteTypes = {
corneredTileSpriteType = {
name = "GFX_<name>"
textureFile1 = <path>
textureFile2 = <path>
effectFile = <path
}
}
</pre>

'''name''' is the name you have given to the asset. This may be prefixed with various other segments, such as ''idea'' for idea images, etc.

'''textureFile1''' is the image to use for the shield background

'''textureFile2''' is the image to use for the shield mask.

'''effectFile''' is used to define an effect state to apply to the image, i.e. the button press effect on a button image. Effects are found in {{path|gfx/FX/*.lua}}. Multiple can be defined to add multiple effects.

= Object Types =
{{SVersion|1.5}}

== animatedmaptext ==
{{SVersion|1.5}}

A '''animatedmaptext''' asset entry is used for text that appears from the map. It follows this format:

<pre>
objectTypes = {
animatedmaptext = {
name = <name>
speed = <float>
textblock = {
text = <string>
color = { <r> <g> }
font = <path>
position = {
x = <int>
y = <int>
}
size = {
x = <int>
y = <int>
}
format = <type>
cull_distance = <float>f
}
}
}
</pre>

'''name''' is the name of the map text. It is not possible to add custom ones.

'''speed''' is the fade time of the text.

'''textblock''' controls the attributes of the text that appears.

= Font Types =
{{SVersion|1.5}}

== textcolors ==
{{SVersion|1.5}}

A '''textcolors''' entry defines the text colors used in localization with the § symbol. It follows this format:

<pre>
bitmapfonts = {
textcolors = {
<symbol> = { <r> <g> }
}
}
</pre>

'''symbol''' is the character used in the localization, i.e. '''H'''.

'''RGB''' is the color that the symbol applies. It is integer RGB.

== bitmapfont ==
{{SVersion|1.5}}

A '''bitmapfont''' entry defines a font used in the game. It follows this format:

<pre>
bitmapfonts = {
bitmapfont = {
name = <name>
path = <path>
color = <hex>
border_color = <hex>
fontfiles = {
<path>
<path>
}
textcolors = {
<symbol> = { <r> <g> }
}
cursor_offset = {
<int>
<int>
}
}
}
</pre>

'''name''' is the name of the font.

'''path''' is the path to the font. Fonts are found in {{path|gfx/fonts/}}.

'''color''' is the default color of the font. It is a hexidecimal RGB code.

'''border_color''' is the border color of the font. It is a hexidecimal RGB code.

'''fontfiles''' is used when their are multiple font images for one font, i.e. to support English and Cryllic. This is used inplace of '''path'''.

'''textcolors''' alters the global textcolors for the font it is nested within.

'''cursor_offset''' offsets the text cursor for the font. Defines the ''x'' position and then the ''y'' position.

== bitmapfont_override ==
{{SVersion|1.5}}

A '''bitmapfont_override''' entry is used to override a font for a specific locale. It follows this format:

<pre>
bitmapfonts = {
bitmapfont_override = {
name = <name>
fontfiles = {
<path>
<path>
}
languages = {
<language>
<language>
}
}
}
</pre>

'''name''' is the name of the font to override.

'''fontfiles''' is used when their are multiple font images for one font, i.e. to support English and Cryllic. This is used inplace of '''path'''.

'''languages''' defines which languages this override applies for.

{{Modding navbox}}
[[Category:Modding]]