讨论

Interface modding：修订间差异

本页面讲述的内容长期有效。
（merge from offical wiki）
 
无编辑摘要
第1行： 第1行：
{{Version|Timeless}}
{{Version|Timeless}}
In Hearts of Iron IV, the interface refers to the user interface the player uses to interact with the game.
在《钢铁雄心IV》中，接口是指玩家用来与游戏交互的用户界面。


== Overview ==
== 概述 ==
The components of an interface file can be broken into two groups: containers and elements. For example, ''containerWindowType'' is a container, whereas ''iconType'' is an element.
接口文件的组件可以分为两组：容器和元素。例如，''containerWindowType'' 是一个容器，而 ''iconType'' 是一个元素。


An interface file uses the '''.gui''' filetype. All interface files are found in {{path|interface/}}.
接口文件使用 .gui 文件类型。 所有接口文件都可以在 {{path|interface/}} 中找到。


When ''internal'' is used here, it is referring to the source code that only Paradox can edit. In short, it means the subject it refers to is not modifiable.
当出现 ''internal''  字样时，这个部分的源代码是只有P社可以修改的，即它所指的主题是不可修改的。


== Macros ==
== 宏 ==
Macros can be used within interface files to make adjusting positions easier.
可以在界面文件中使用宏，以便更轻松地调整位置。


This for example would make a macro called '''WINDOW_X_POS''' with the value of 10.
例如，这将使一个名为 WINDOW_X_POS 的宏，其值为 10 。
<pre>@WINDOW_X_POS = 10</pre>
<pre>@WINDOW_X_POS = 10</pre>


This can then be referred to in an element like so:
可以在元素中这样引用它：
<pre>
<pre>
containerWindowType = {
containerWindowType = {
第25行： 第25行：
</pre>
</pre>


== Containers ==
== 容器 ==
Containers are used to group together elements and associate them with an internal function.
容器用于将元素组合在一起，并将它们与内部函数相关联。


You cannot add new containers except through [[Scripted_GUI_modding|Scripted GUI]]. This is because the ''name'' attribute of a container is linked internally to whatever data the container requires. There are exceptions to this, a common one is that you can add new containers for custom technology folders in ''countrytechtreeview.gui'''.
除非通过[[Scripted GUI modding| 脚本化 GUI ，]] 否则无法添加新容器。这是因为容器的 ''name'' 属性在内部链接到容器所需的任何数据。常见的例外是，您可以在 ''countrytechtreeview.gui'' 中为自定义技术文件夹添加新容器。


The order and nesting of container definitions affects how they are displayed.
容器定义的顺序和嵌套会影响它们的显示方式。


== containerWindowType ==
== containerWindowType ==
The most common container type, used to hold any group of elements.
最常见的容器类型，用于保存任何一组元素。


The following attributes are commonly used:
通常使用以下属性：
* '''name''' - The container name.
* '''name''' - 容器的名称。
* '''background''' - An element to use as the container background.
* '''background''' - 容器的背景。
* '''position''' - The screen position of the container.
* '''position''' - 容器的屏幕位置。
* '''size''' - The bounding box for the container. Can be in percentage (i.e. 100%%) 
* '''size''' - 容器的边界框。接受百分数( 如 100%% ) 。
* '''moveable''' - Sets whether the container can be dragged around.
* '''moveable''' - 设置是否可以拖动容器。
* '''fullscreen''' - Sets whether the container is considered to obscure the whole screen.
* '''fullscreen''' - 设置是否将容器全屏化。
* '''orientation''' - Sets the orientation origin for the ''position'' attribute.
* '''orientation''' - 设置 ''position'' 属性的方向原点。
* '''clipping''' - Sets whether the container will clip other elements (i.e. cut their elements at boundary).
* '''clipping''' - 设置容器是否将修剪其他元素（如在边界处剪切其元素）。


The following attributes are used for animated containers:
以下属性用于动画容器：
* '''show_position''' - The screen position the container moves to in ''show'' mode.
* '''show_position''' - 容器在'' 显示'' 模式下移动到的屏幕位置。
* '''hide_position''' - The screen position the container moves to in ''hide'' mode.
* '''hide_position''' - 容器在'' 隐藏'' 模式下移动到的屏幕位置。
* '''show_animation_type''' - The animation type used to show the container (always ''decelerated'').
* '''show_animation_type''' - The animation type used to show the container (always ''decelerated''). 用于显示容器的动画类型（始终''减速）''。
* '''hide_animation_type''' - The animation type used to hide the container (always ''accelerated'').
* '''hide_animation_type''' - The animation type used to hide the container (always ''accelerated''). 用于隐藏容器的动画类型（始终''加速）。''
* '''animation_time''' - The animation time (always ''300'').
* '''animation_time''' - 动画播放时间（始终'' 为 300'' ）。
* '''upsound''' - The sound to play when container moves to ''show'' position.
* '''upsound''' - 当容器移动到'' 显示'' 位置时要播放的声音。
* '''downsound''' - The sound to play when container moves to ''hide'' position.
* '''downsound''' - 当容器移动到'' 隐藏'' 位置时要播放的声音。
* '''fade_time''' - The time to fade in.
* '''fade_time''' - 淡入淡出的时间。
* '''fade_type''' - The type of fade in. (always ''linear'').
* '''fade_type''' - 淡入的类型（始终为'' 线性'' ）。


The following attributes are rarely or never used:
以下属性很少或从不使用：
* '''dontRender'''
* '''dontRender''' - 不渲染
* '''horizontalBorder'''
* '''horizontalBorder''' - 水平边界
* '''verticalBorder'''
* '''verticalBorder''' - 垂直边界


== scrollbarType ==
== scrollbarType ==

2022年7月11日 (一) 23:14的版本

在《钢铁雄心IV》中，接口是指玩家用来与游戏交互的用户界面。

概述

接口文件的组件可以分为两组：容器和元素。例如，containerWindowType 是一个容器，而 iconType 是一个元素。

接口文件使用 .gui 文件类型。 所有接口文件都可以在 /Hearts of Iron IV/interface/ 中找到。

当出现 internal 字样时，这个部分的源代码是只有P社可以修改的，即它所指的主题是不可修改的。

宏

可以在界面文件中使用宏，以便更轻松地调整位置。

例如，这将使一个名为 WINDOW_X_POS 的宏，其值为 10。 

@WINDOW_X_POS = 10

可以在元素中这样引用它： 

containerWindowType = {
    name = "my_container"
    position = { x = @WINDOW_X_POS y = -600 }

    # ...
}

容器

容器用于将元素组合在一起，并将它们与内部函数相关联。

除非通过脚本化 GUI，否则无法添加新容器。这是因为容器的 name 属性在内部链接到容器所需的任何数据。常见的例外是，您可以在 countrytechtreeview.gui 中为自定义技术文件夹添加新容器。

容器定义的顺序和嵌套会影响它们的显示方式。

containerWindowType

最常见的容器类型，用于保存任何一组元素。

通常使用以下属性：

  • name - 容器的名称。
  • background - 容器的背景。
  • position - 容器的屏幕位置。
  • size - 容器的边界框。接受百分数( 如 100%% )。
  • moveable - 设置是否可以拖动容器。
  • fullscreen -设置是否将容器全屏化。
  • orientation - 设置 position 属性的方向原点。
  • clipping - 设置容器是否将修剪其他元素（如在边界处剪切其元素）。

以下属性用于动画容器：

  • show_position - 容器在显示模式下移动到的屏幕位置。
  • hide_position - 容器在隐藏模式下移动到的屏幕位置。
  • show_animation_type - The animation type used to show the container (always decelerated).用于显示容器的动画类型（始终减速）。
  • hide_animation_type - The animation type used to hide the container (always accelerated).用于隐藏容器的动画类型（始终加速）。
  • animation_time - 动画播放时间（始终为 300）。
  • upsound - 当容器移动到显示位置时要播放的声音。
  • downsound - 当容器移动到隐藏位置时要播放的声音。
  • fade_time - 淡入淡出的时间。
  • fade_type - 淡入的类型（始终为线性）。

以下属性很少或从不使用：

  • dontRender - 不渲染
  • horizontalBorder - 水平边界
  • verticalBorder - 垂直边界

scrollbarType

The scrollbarType is used to define which elements a scrollbar is composed of.

The following attributes are used:

  • name - The scrollbar name.
  • slider - The button element to use as the scrollbar slider.
  • track - The button element to use as the scrollbar tracker.
  • leftbutton - The button element to use as the scrollbar left increment button.
  • rightbutton - The button element to use as the scrollbar right increment button.
  • position - The screen position of the scrollbar.
  • size - The bounding box for the scrollbar.
  • priority - The priority the scrollbar has over other elements.
  • borderSize - The bounding box for border of the scrollbar.
  • maxValue - The maximum value the scrollbar moves to (used to control the increments).
  • minValue - The minimum value the scrollbar moves to (used to control the increments).
  • stepSize - The size of increments using the increment button.
  • startValue - The initial size the slider for the scrollbar starts at.
  • horizontal - Sets whether the scrollbar is horizontal (1) or vertical (0).

Elements

There are multiple element types used within containers. All elements must be used within containers, they will not work outside of one.

Elements will inherit the orientation of the containers they are located in unless the orientation is specified for the element itself.

The following elements can be freely added and are usable with scripted GUIs.

  • iconType - Used for static images.
  • instantTextBoxType - Used for text.
  • buttonType - Used for buttons

The following elements do rely on internal code. You can add new elements, they will not be populated with data.

  • smoothListboxType - Used for smooth scrollable lists.
  • listboxType - Used for scrollable lists.
  • checkboxType - Used for checkboxes.
  • OverlappingElementsBoxType - Used for overlapping many elements.
  • editBoxType - Used for editable textboxes.
  • shieldtype - Used for to display country flags.

The following elements are legacy:

  • guiButtonType - Same as buttonType.
  • textBoxType - Same as instantTextBoxType.
  • eu3dialogtype - Same as windowType.
  • shieldtype - Only used within eu3dialogtype. Different elements are used for flags in more recent files.

iconType

The iconType element is used to add images to the interface. It's usage overlaps with buttonType, which is similar but operates as a button.

The following attributes are used:

  • name - The icon name.
  • position - The screen position of the icon.
  • orientation - Sets the orientation origin for the position attribute.
  • spriteType - The image to use for the icon. Refers to a spriteType definition.
  • quadTextureSprite - The image to use for the icon. Refers to a dynamic spriteType definitions (i.e. flags) or multi-frame spriteType definitions.
  • frame - Which frame to use for the icon when using a multi-frame image.
  • alwaystransparent - Forces the icon to allow click through, i.e. clicking on an element behind another element.
  • hint_tag - Set the hint key the icon uses to display a hint tooltip with when hovered over.
  • pdx_tooltip - Sets the tooltip to display to the player. Takes a localization key.
  • pdx_tooltip_delayed - Sets the delayed tooltip to display to the player. Takes a localization key.
  • centerposition - Sets whether the position is from the center of the icon.

instantTextBoxType

The instantTextBoxType element is used to add text to the interface. In some instances, the text for the element is generated internally (i.e. regiment_count). In these instances you cannot edit the text unless it is exposed in an localized string.

The following attributes are used:

  • name - The textbox name.
  • position - The screen position of the textbox.
  • orientation - Sets the orientation origin for the position attribute.
  • text - The text displayed by the textbox.
  • font - The font to use for the text.
  • maxWidth - The total width in pixels at which text is displayed.
  • maxHeight - The total height in pixels at which text is displayed.
  • format - How the text is aligned.
  • fixedsize - Whether the textbox should truncate text that exceeds its limits.
  • borderSize - The bounding box for the border of the textbox.
  • alwaystransparent - Forces the text to allow click through, i.e. clicking on an element behind another element.
  • pdx_tooltip - Sets the tooltip to display to the player. Takes a localization key.
  • pdx_tooltip_delayed - Sets the delayed tooltip to display to the player. Takes a localization key.

The following attributes are rarely or never used:

  • textureFile - Never used for anything.

Valid format values:

  • left
  • centre
  • right

buttonType

The guiButtonType' element is used to add buttons to the interface. Buttons are composed of an image and text, so they operate in a similar manner to iconType and instantTextBoxType.

The following attributes are used:

  • name - The button name.
  • position - The screen position of the button.
  • orientation - Sets the orientation origin for the position attribute.
  • spriteType - The image to use for the button. Refers to a spriteType definition.
  • quadTextureSprite - The image to use for the button. Refers to a dynamic spriteType definitions (i.e. flags) or multi-frame spriteType definitions.
  • frame - Which frame to use for the button when using a multi-frame image.
  • alwaystransparent - Forces the button to allow click through, i.e. clicking on an element behind another element.
  • buttonText - The text displayed by the button.
  • buttonFont - The font to display the button text in.
  • shortcut - The shortcut to add for this button.
  • clicksound - The sound to use when clicked.
  • oversound - The sound to play when hovered over.
  • hint_tag - Set the hint key the icon uses to display a hint tooltip with when hovered over.
  • pdx_tooltip - Sets the tooltip to display to the player. Takes a localization key.
  • pdx_tooltip_delayed - Sets the delayed tooltip to display to the player. Takes a localization key.
  • scale - Scales the button size.

The following attributes are rarely or never used:

  • tooltip - Never used.
  • tooltipText - Never used.
  • delayedTooltipText - Never used.

smoothListboxType

The smoothListboxType element is used to define a listbox, which is a scrollable list that is populated with entries. Typically these elements are internally linked with another container, which composes the actual entry used in the list box.

The following attributes are used:

  • name - The listbox name.
  • position - The screen position of the listbox.
  • orientation - Sets the orientation origin for the position attribute.
  • size - The bounding box for the listbox.
  • spacing - The spacing to use between listbox entries.
  • 'horizontal - Whether the listbox is horizontal (1) or vertical (0).
  • scrollbartype - The scrollbar to use for the listbox.
  • bordersize - The bounding box for the border for the listbox.
  • alwaystransparent - Forces the listbox to allow click through, i.e. clicking on an element behind another element.

The following attributes are rarely or never used:

  • background - Never used.

listboxType

The listboxType element is used to define a listbox, which is a scrollable list that is populated with entries. Typically these elements are internally linked with another container, which composes the actual entry used in the list box.

The following attributes are used:

  • name - The listbox name.
  • position - The screen position of the listbox.
  • orientation - Sets the orientation origin for the position attribute.
  • size - The bounding box for the listbox.
  • spacing - The spacing to use between listbox entries.
  • 'horizontal - Whether the listbox is horizontal (1) or vertical (0).
  • scrollbartype - The scrollbar to use for the listbox.
  • bordersize - The bounding box for the border for the listbox.
  • alwaystransparent - Forces the listbox to allow click through, i.e. clicking on an element behind another element.

The following attributes are rarely or never used:

  • background - Never used.

checkboxType

The checkboxType element is used to add checkboxes to the interface. The actual effect of the checkbox is defined internally.

The following attributes are used:

  • name - The checkbox name.
  • position - The screen position of the checkbox.
  • orientation - Sets the orientation origin for the position attribute.
  • spriteType - The image to use for the checkbox. Refers to a spriteType definition.
  • quadTextureSprite - The image to use for the checkbox. Refers to a dynamic spriteType definitions (i.e. flags) or multi-frame spriteType definitions.
  • frame - Which frame to use for the checkbox when using a multi-frame image.
  • alwaystransparent - Forces the checkbox to allow click through, i.e. clicking on an element behind another element.
  • buttonText - The text displayed by the checkbox.
  • buttonFont - The font to display the checkbox text in.
  • shortcut - The shortcut to add for this checkbox.
  • clicksound - The sound to use when clicked.
  • hint_tag - Set the hint key the checkbox uses to display a hint tooltip with when hovered over.
  • pdx_tooltip - Set the short tooltip this checkbox uses.
  • pdx_tooltip_delayed - Set the full tooltip this checkbox uses.
  • scale - Scales the checkbox size.

The following attributes are rarely or never used:

  • tooltip - Never used.
  • tooltipText - Never used.
  • delayedTooltipText - Never used.

editBoxType

The editBoxType element is used to add editable textboxes to the interface.

The following attributes are used:

  • name - The textbox name.
  • position - The screen position of the textbox.
  • orientation - Sets the orientation origin for the position attribute.
  • text - The text displayed by the textbox.
  • font - The font to use for the text.
  • maxWidth - The total width in pixels at which text is displayed.
  • maxHeight - The total height in pixels at which text is displayed.
  • format - How the text is aligned.
  • fixedsize - Whether the textbox should truncate text that exceeds its limits.
  • borderSize - The bounding box for the border of the textbox.
  • alwaystransparent - Forces the text to allow click through, i.e. clicking on an element behind another element.
  • ignore_tab_navigation - Makes the element ignore tab navigation.

OverlappingElementsBoxType

The OverlappingElementsBoxType element is used to define a special kind of listbox that dynamically overlaps sub-elements within itself.

The following attributes are used:

  • name - The listbox name.
  • position - The screen position of the listbox.
  • orientation - Sets the orientation origin for the position attribute.
  • size - The bounding box for the listbox.
  • spacing - The spacing to use between listbox entries.
  • 'horizontal - Whether the listbox is horizontal (1) or vertical (0).
  • bordersize - The bounding box for the border for the listbox.
  • alwaystransparent - Forces the listbox to allow click through, i.e. clicking on an element behind another element.

The following attributes are rarely or never used:

  • textureFile - Never used for anything.

Valid format values:

  • left
  • centre
  • right

Position and Orientation

Understanding how the position coordinates work is important to understanding how to edit interfaces correctly.

The orientation attribute used by an element (or container) informs you where the anchor point for the element is. For example, UPPER_LEFT means the ( 0, 0 ) position is in the top left corner of the screen, whereas LOWER_RIGHT is the bottom right.

The position attribute then works from this origin position. Therefore if you want an element to be on the opposite side of the screen, you'd want to change the orientation first.

This is system is used because it allows the interface to adapt to different resolutions. Because all positions are tied to a specific origin that is dynamically calculated from the player's screen resolution, the placement of containers and elements are kept consistent.

So, if you want to ensure your interface edits are consistent, you must use the orientation attribute properly.

An mistake would be to edit the position solely, for example position = { x = 1800 y = 200 }. This would look fine for anybody with a screen width greater than 1800px (i.e. 1900 x 1200 upwards), but the element would be off screen for those with smaller screens.

Valid orientation values (can be upper or lowercase):

  • CENTER
  • UPPER_LEFT
  • LOWER_LEFT
  • UPPER_RIGHT
  • LOWER_RIGHT

Fonts

See also: Font modding

The following fonts are usable in Hearts of Iron IV:

  • Arial12
  • Arial12_bold
  • cg_16b
  • cg_18b
  • garamond_12
  • garamond_14
  • garamond_14_bold
  • garamond_16
  • garamond_16_bold
  • garamond_24
  • hoi_16mbs
  • hoi_16tooltip3
  • hoi_16typewriter
  • hoi_18
  • hoi_18b
  • hoi_18mbs
  • hoi_20b
  • hoi_20bs
  • hoi_22tech
  • hoi_22typewriter
  • hoi_24header
  • hoi_26mbs
  • hoi_30header
  • hoi_33
  • hoi_36header
  • hoi4_typewriter16
  • hoi4_typewriter22
  • hoi_mapfont4
  • hoi_arrow_font
  • newsfeed_body
  • newsfeed_title
  • standard
  • standard_18
  • standard_22
  • tahoma_20_bold
  • vic_18
  • vic_18_grey
  • vic_18s
  • vic_22
  • vic_22_bl
  • vic_22s
  • vic_36
  • vic_36s


模组制作 
文件 效果 • 条件 • 定义 • 修正 • 修正列表 • 作用域 • 本地化 • on action • 数据结构 (标记, 临时标记, 国家别名, 变量, 数组)
脚本 成就修改 • AI修改 • AI focuses • 自治领修改 • 权力平衡修改 • 剧本/标签 (游戏规则)• 建筑修改 • 人物修改 • 修饰性TAG修改 • 国家创建 • 军队修改 • 决议制作 • 装备修改 • 事件修改 • Idea修改 • 意识形态修改 • 军工商修改 • 国策制作 • 资源修改 • Scripted GUI • 科技制作 • 单位修改
地图 地图 • 省份 • 补给区域 • 战略区域
图形图像 界面 • 图形资产 • 实体模型 • 后期特效 • 离子效果 • 字体
装饰性 肖像 • 命名列表 • 音乐 • 音效
其他 控制台指令 • 故障排除 • 模组结构 • 成就代码分析 • Mod相关 • Nudger修改