编辑“界面”

{{Version|timeless}}{{需要翻译}}
CK3的用户界面（UI）是高度可修改的，但由于这个原因，UI修改器会禁用成就，因为玩家可能会用它们作弊。

游戏还包含一个GUI编辑器，可以在游戏中检查UI元素并编辑它们。

模组作者可以：
* 改变界面的视觉风格
* 使窗口可以移动和调整大小。
* 更改和删除要素
* 增加新的按钮
* 从代码中显示更多信息
* 增加新的窗口（有一个变通办法）

模组作者不能：
* 增加新的热键（只能重复使用现有的热键）。
* 在另一个窗口中显示一个窗口的信息，除非开发者包含这种可能性。


== 基础 ==

CK3的界面是通过game/gui文件夹中的.gui文件创建的，它有点类似于html文件。

因此，你可以用任何文本编辑器来编辑它们，比如[[模组制作#提示 & 指引| VS Code, Sublime 或 Atom]]。语法高亮选择Python或Perl 6，它们很适合。

CK3使用.dds文件来制作纹理，它保存在game/gfx/文件夹内。

要编辑或保存.dds文件，可以使用带有[https://software.intel.com/en-us/articles/intel-texture-works-plugin Intel 插件]的Photoshop或带有[https://code.google.com/archive/p/gimp-dds/downloads 此插件]的GIMP。


要在游戏中重新加载gui文件并使用GUI编辑器，添加-debug_mode和-develop启动选项。
* 在Steam上右击游戏，选择属性，设置启动选项，添加<code>-debug_mode -develop</code>。

你可以使用以下控制台指令：
*<code>reload gui</code> - 重载所有的gui文件，以显示游戏中的任何变化。
* <code>reload texture</code> - 重新加载所有纹理文件。
* <code>gui editor</code> - 打开GUI编辑器。
*<code>tweak gui.debug</code> - 允许启用UI元素的高亮显示。提示工具条将显示其名称、大小和位置。
*<code>DumpDataTypes</code> - 将在你的日志文件夹（Documents/Paradox Interactive/Crusader Kings III/logs）中创建一个data_types.log，列出每个窗口/游戏对象的所有可用的GUI函数。

其他提示。
* 始终打开错误日志，查看代码中是否有错误（在同一个日志文件夹中）。
* 点击控制台下方的“Toggle Release Mode”启用游戏中的错误跟踪器，查看你的更改是否导致任何新的错误。
* 当使用<code>reload gui</code>命令时，将游戏静音，因为每次都会触发前奏的声音。
* 使用[https://steamcommunity.com/sharedfiles/filedetails/?id=2269399705 Reload GUI mod]，它增加了一个重新加载gui的按钮（用热键），并在你重新加载时关闭设置窗口。
* 将gui文件夹添加到你的文本编辑器中，这样它就会使用它来自动完成。
* 你可以在gui/debug中使用test_gui.gui进行测试。要显示这个窗口，打开控制台并点击测试窗口。
* 折叠代码，这样更容易看到它的结构。通常的热键是Ctrl+K、Ctrl+1（其中1是折叠代码的级别）。

== 创建GUI模组 ==

1. 启动游戏启动器，进入Mods，Mod工具，填写所有字段，包括标签。

点击创建会在<code>Documents/Paradox Interactive/Crusader Kings III/mod</code>中新建一个文件夹和一个.mod文件。

2. 接下来，在你的模组里创建一个“gui”文件夹，然后从game/gui里复制你要修改的文件到那里。

* 如果你不知道需要哪个文件，请使用GUI编辑器，并在游戏中检查它。

== GUI编辑器 ==

GUI编辑器（GUI Editor）是一款用于编辑游戏中UI的开发者工具。

要使用它，你需要在<code>-debug_mode</code>和<code>-developer</code>选项下启动游戏。


要打开编辑器，可以选择
* 按Ctrl+F8键
* 用`键（在Esc下面）打开控制台，点击GUI编辑器。
* 打开控制台，运行gui_editor命令。

=== 特点 ===
默认情况下，编辑器启动时启用了编辑模式。你可以在顶部窗口中禁用它，称为Outliner。热键“E”。

* 编辑模式类似于浏览器中的检查模式。当它被启用时，你不能与游戏互动，但它允许你选择UI的一部分，并在下面的属性窗口中更改它们。
* 滚动鼠标滚轮来改变编辑器应该关注的元素，因为hud.gui往往会被放在其他窗口之上。
* 黄色边框表示选中的元素。要隐藏其他边框，请取消勾选Outliner中的“Show Hierarchy”（热键“L”）。
* 按住鼠标右键可以移动所选元素。
* 要撤销任何操作，请按Ctrl+Z或Outliner中的撤销按钮。重做是旁边的按钮，Ctrl+Y。
* Outliner中的红星*表示未保存的更改。按Ctrl+S或顶部的保存按钮来保存它们。确保你正在编辑的gui文件在你的模组中，否则它会将更改写入游戏文件夹。(要重置它们，请从Steam的属性窗口验证完整性)
* 你可以通过拖动任何开发窗口来移动它们，并通过拖动边缘来调整它们的大小。
* 您可以在Outliner的层次结构中拖动UI元素来重新排序。右键单击以显示上下文菜单。
* 您可以在“属性（Properties）”窗口中更改或添加新属性（通过单击加号）。


通过单击Outliner中的“窗口（Window）”，您可以打开另外两个窗口。UI组件（UI components）和注册数据类型（Registered Data Types）。
* UI组件就像一个调色板，你可以拖动新的元素到UI中。gui/shared/standard.gui和gui/defaults.gui包含最常见的东西，如按钮、图标和文本。
* 注册数据类型可以用来查找能够显示游戏中数据的函数。
* 点击数据类型中的右上角按钮会将这些数据转储到你的日志文件夹（Documents/Paradox Interactive/CK3/logs）。你也可以使用“DumpDataTypes”控制台指令。


注意：通常很容易误选一个模板，改变模板会影响UI中的''所有''实例。留意你在Outliner中选择了哪些文件。如果你在属性（Properties）窗口中看到一个以“type:”开头的蓝色标题，那就是一个模板，所以要注意不要编辑这部分内容（除非你打算编辑）。

== UI代码 ==

CK3的UI是由容器和容器内的对象组成的。

例如，大多数窗口都是使用<code>window</code>容器创建的，而地图图标则使用widget或hbox。

文件中的顺序决定了屏幕上的顺序：代码中较低的东西会出现在较高的一层。

大多数元素也可以包含其他元素，例如，在一个按钮的图标里面可以有一个文本框。嵌套的元素，也就是子元素，将和它们的父元素一起移动。

位置是相对于左上角设置的（屏幕或父元素）。这可以通过<code>parentanchor</code>属性来改变。可用的选项有：左、右、上、下、hcenter（水平中心）和vcenter（垂直中心）。它们可以像这样与|组合。<code>parentanchor = right|vcenter</code>。

每个元素都用大括号打开和关闭，像这样。<code>container = { }</code>。

常见的代码风格是在同一层次上打开和关闭块，同时用一个标签缩进内容。

<pre>
widget = {
  size = { 50 50 }
  alpha = 0.5
}
</pre>

这可以帮助你更好地看到代码的结构，注意到任何缺失的或额外的括号，对于一些编辑器来说，这也是正确折叠代码块所需要的。

=== UI组件 ===

<code>window</code>

* 唯一可移动的容器。要启用移动，添加<code>movable = yes</code>属性。
* 可以固定大小，也可以由其子代调整大小。
* 在游戏中，背景是通过模板设置的，比如<code>using = Window_Background</code>和<code>using = Window_Decoration</code>。
* 如果一个孩子在窗口之外，它将无法被点击，也不会显示工具提示。使用<code>allow_outside = yes</code>来改变这一点。没有z坐标，所以z的排序方式是第一个写的子代会被放在第二个写的子代后面。为了使组件可以点击，并且在其他组件的顶部，你需要把它放在其他组件的后面。

<code>widget</code>

* 一个静态容器。在其他方面类似于一个窗口。

<code>margin_widget</code>

* 类似于widget，但可以用margins调整大小。(这使我们可以通过将高度设置为100%，将边距设置为约50，使窗口可以调整到不同大小的屏幕上，以显示hud)

<code>container</code>

* 没有固定的尺寸（但你可以设置最大尺寸）。
* 自动调整大小以适应所有子代，包括不可见的子代。使用<code>ignoreinvisible = yes</code>来忽略它们。
* 常用于将多个元素组合在一起移动。

<code>flowcontainer</code>

* 将其所有子代排列成水平行。使用<code>direction = vertical</code>使其垂直。
* 默认情况下不会忽略不可见的子代。使用<code>ignoreinvisible = yes</code>来改变它。
* 没有固定的大小，可以使用<code>ignoreinvisible = yes</code>来改变。
* 它的子代不能有位置，因为它们是自动设置的。
* 如果你需要调整它的子代的位置，你可以把它放在一个容器或widget里面，然后改变相对于这个父代的位置。

<code>hbox</code>
<code>vbox</code>

* 将所有的子代排列成水平的一行，并沿其宽度分布。Vbox也是一样的，但是是垂直的。
* 不能有固定的大小，而是取其父代的宽度作为自己的宽度（忽略父代的边距）。Vbox取其高度。
** 如果它的父体不能有固定的大小（如flowcontainer），这可能会导致游戏崩溃。
* 可受最小尺寸/最大尺寸和边距的限制。
* 默认情况下，忽略不可见的子代，使用<code>ignoreinviser。使用<code>ignoreinvisible = no</code>来更改。
* 在另一个hbox中的hbox将有0个大小，并且不会展开其子代。使用<code>layoutpolicy_horizontal = expanding</code>来调整它的大小（或者在vbox中使用<code>layoutpolicy_vertical = expanding</code>）。
* 接受数据模型（从游戏数据中创建列表）。

通过www.DeepL.com/Translator（免费版）翻译

<code>dynamicgridbox</code>

* Is only used with datamodels.
* Arranges all the items vertically. Use <code>flipdirection = yes</code> to make it horizontal.
* Doesn't ignore invisible items by default. Use <code>ignoreinvisible = yes</code> to change it.
* Can be fixed size, resized by the content and limited by minimumsize and maximumsize.
* Items can be of different size.
* Can become laggy with very long lists.

<code>fixedgridbox</code>

* Similar to a dynamic box but all its itmes are of fixed size (it's essentially a table).
* Is only used with datamodels.
* Arranges all its items vertically. Use <code>flipdirection = yes</code> to make it horizontal.
* Cannot ignore invisible items.
* Can be fixed size, resized by the content and limited by minimumsize and maximumsize.
* Much better for performance with long lists.

<code>overlappingitembox</code>

* Is only used with datamodels.
* Arranges all its items horizontally and overlaps them if the list is longer that the size of the box. Use <code>flipdirection = yes</code> to make it horizontal.
* Can be fixed size or autoresized.

<code>scrollarea</code>

* A widget with scrollbars that appear if the content is bigger than its size.
* Scrollbars can be disabled with <code>scrollbarpolicy_horizontal = always_off</code> and <code>scrollbarpolicy_vertical = always_off</code>.
** A scrollarea with no scrollbars can be used to crop lists or images.
* Can be fixed size, resized by the content and limited by minimumsize and maximumsize.

<code>button</code>

* A clickable object. Accepts <code>onclick</code> and <code>onrightclick</code>.
** When adding a right click function, include <code>button_ignore = none</code>.
* Doesn't have a texture by default.
* Can be fixed size or resized by its children.
** A 0x0 button can be used to add invisible hotkeys.

<code>icon</code>

* Displays a texture.
* Can be used as a widget to store children.
* Can be flipped with <code>mirror = horizontal</code> or <code>mirror = vertical</code>.

<code>textbox</code>

* Shows text.
* Can be fixed size or autoresized.
* Use <code>elide = right</code> or <code>elide = left</code> to cut off text that is too long
* Can be a single line or multiple, with <code>multiline = yes</code>.
* Game files often use templates set in gui/shared/text.gui, like <code>text_single</code>. Use them to keep visual consistency and to type less code every time.

=== Promotes and Functions ===

Each window has a predefined set of commands - promotes and functions - available for it. These can be found in the data_types.log file in <code>Documents/Paradox Interactive/Crusader Kings III/logs/</code> after you use the <code>DumpDataTypes</code> console command.

They are used to display all data from the game, like your name, gold, children, and to set button actions.

A promote returns a scope, i.e a game object, like Character or Province, while a function returns a number, a string or a boolean (true/false) value, etc.

Global commands can be used anywhere, like GetPlayer (returns the player character) or GetCurrentDate.

Other commands can only be used in their window/object, for example, GetParents can only be used in the character window and must be started with <code>CharacterWindow.GetParents</code>.

Commands can be chained like this:

<code>CharacterWindow.GetCharacter.GetPrimaryTitle.GetHeir.GetPrimarySpouse.GetFather</code>

Children can inherit the scope from their parent, meaning we wouldn't need to retype the line above to show information about this character. Instead we can set <code>datacontext</code> of a widget to this line and then every textbox in it will use <code>"[Character.GetNameNoTooltip]"</code>, <code>"[Character.GetGold]"</code>, etc.

The same applies to items in gridboxes.

=== Templates ===

Templates are named blocks of code which can be used multiple times throughout the code, which helps maintain the same style and reduce the amount of code we write. Editing the template will edit all instances of it!

Templates are global and can be defined in any file. Most of the game templates are stored in gui/shared. A local version, local_template, has to be defined within the same file.

Templates can store the contents of an entire window or just one line, like this one:

<pre>
template Window_Size_Sidebar
{
		size = { 610 100% }
}
</pre>

This template can be used inside another element with "using = Window_Size_Sidebar", which will, essentially, replace the "using" line with the contents of the template.

==== Types ====

If templates can contain just a few properties, types are always whole elements, like a button or a widget.

text_single and text_multi are types of a textbox with many properties already defined for them, so we don't need to retype them every time and instead simply write:

<pre>
text_single = {
	text = "my text"
}
</pre>

Types are defined in a slightly different way, by creating a named group of types first:

<pre>
types Standard_Types
{
	type text_single = textbox {
	...
	}
}
</pre>

==== Blockoverride ====

Templates and types can have named override blocks, which allow us to edit a part of an instance without changing the whole template. For example, a template may have a default block of text:

<pre>
block "text"
{
	text = "default_text"
}
</pre>

To replace it, we add a blockoverride with the same name in our instance:

<pre>
blockoverride "text"
{
	text = "actual text"
}
</pre>

We can also remove it from our instance like this:
<code>blockoverride "text" {}</code>

== Scripted GUIs ==

Scripted guis are, essentially, hidden events triggered from the UI.

The are stored as .txt files in game/common/scripted_guis and cannot be reloaded from the game, unlike the .gui files.

The basic structure of a scripted gui is:

<pre>
gui_name = { 
	scope = character 		# the root scope, i.e. the target of the effects
	saved_scopes = {} 		# any additional targets

	is_shown = {} 		# is it visible on the UI?

	ai_is_valid = {} 		# is the AI allowed to use it? Disabled by default.

	is_valid = {} 		# can the player use it?

	effect = {			# what it does
		custom_tooltip = ""	# adds a tooltip
	}	 			
}
</pre>
 
Not all of the blocks are necessary. Sometimes a scripted gui may only contain the scope and is_shown or effect.

In the .gui file we use the following:

<pre>
datacontext = "[GetScriptedGui('gui_name')]"

onclick = "[ScriptedGui.Execute( GuiScope.SetRoot( GetPlayer.MakeScope ).End)]"

visible = "[ScriptedGui.IsShown( GuiScope.SetRoot( GetPlayer.MakeScope ).End)]"

enabled = "[ScriptedGui.IsValid( GuiScope.SetRoot( GetPlayer.MakeScope ).End)]"

tooltip = "[ScriptedGui.BuildTooltip( GuiScope.SetRoot( GetPlayer.MakeScope ).End)]"
</pre>

datacontext is necessary to link the element to the scripted gui. Other commands won't work without it.

In this example the scripted gui is scoped to the player with a global function <code>GetPlayer.MakeScope</code>. It can be changed to someone in the character window, e.g. <code>CharacterWindow.GetCharacter.MakeScope</code>, or if the scope was a province, <code>HoldingView.GetProvince.MakeScope</code>.

ScriptedGui.Execute is used with buttons and will execute everything listed in the <code>effect</code> block in the scripted gui. 

IsShown and IsValid check for conditions in is_shown and is_valid blocks.

BuildTooltip can also be used with a textbox to display custom text in the UI.

To save another scope to our scripted gui, we use AddScope like this:

 "[ScriptedGui.Execute( GuiScope.SetRoot( GetPlayer.MakeScope ).AddScope('target', CharacterWindow.GetCharacter.MakeScope ).End )]"

And then we use the same name in the scripted gui:

 saved_scope = {
   target
 }

Multiple scopes can be saved this way.

It is important to not put any spaces before the dots or opening parentheses! <code>Execute(</code> is correct, <code>Execute (</code> is not. Other spaces can be omitted, but they help with readability.

=== Displaying a variable or script value ===

Variables and script values can be shown on the UI like this:

variable: <code>text = "[GetPlayer.MakeScope.Var('test_var').GetValue|1]"</code>

svalue: <code>text = "[GuiScope.SetRoot( GetPlayer.MakeScope ).ScriptValue('test_value')|0]"</code>

In this example the variable is stored in the player character and is called test_var. Any other scope can be used, just remember to add MakeScope.

|1 at the end is optional and will cut off all decimals save for one, so instead of 1.573 you will see 1.5. Note that it does not round the value. You can set this at any number, add % to convert to a percentage, add = or + to color the value if it's positive or negative.

When using localization to display values in events, we use this:

<code>event_var: "[ROOT.GetCharacter.MakeScope.Var('test_var').GetValue|0]"</code>

<code>event_value: "[SCOPE.ScriptValue('test_value')|0]"</code>

If you have a saved scope (named "target" here), it changes to this:

<code>event_var: "[target.MakeScope.Var('test_var').GetValue|0]"</code>

<code>event_value: "[GuiScope.SetRoot( target.MakeScope ).ScriptValue('test_value')|0]"</code>

=== Displaying data lists ===

We can create custom lists of characters, for example, to make societies.

To do this, first, we need to add them to a variable list. This can be done though an event or a scripted gui, like this:

<pre>
effect = {
	every_living_character = {
		limit = {
			has_trait = paranoid
		}

		root = {
			add_to_variable_list = {
				name = secret_society
				target = prev
			}
		}
	}
}
</pre>

If we fire this effect for the player, they will be the <code>root</code>, so the list will be stored in them.

Then we use any list box (vbox, dynamicgridbox, fixedgridbox) with the datamodel set to our list:

<pre>
dynamicgridbox = {
	datamodel = "[GetPlayer.MakeScope.GetList('secret_society')]"

	item = {
		flowcontainer = {
			datacontext = "[Scope.GetCharacter]"

			portrait_head_small = {}

			text_single = {
				text = "[Character.GetNameNoTooltip]"
			}
		}
	}
}
</pre>

== New windows and toggles ==

There isn't a simple way to create a new window and make your mod compatible with others. We have to either overwrite the hud or other windows.

The usual way is to add the new window to hud.gui inside of ingame_topbar widget and then add a button to show/hide it.

The alternative is to rewrite one of the unused windows, like test_gui and add a button with the console command that shows it.

=== Toggles with PdxGuiWidget ===

PdxGuiWidget is a simple function used to hide or reveal named elements.

In this example we have a container with a hidden submenu, one button that shows it and another that hides it.
# when clicked, the first button goes back to its parent, searches in it for the submenu and the other button, reveals them and hides itself
# the second button searches for the element and the button, reveals them and hides itself

<pre>
container = {
	button = {
		name = "show submenu"

		onclick = "[PdxGuiWidget.AccessParent.FindChild('submnenu').Show]"
		onclick = "[PdxGuiWidget.AccessParent.FindChild('hide submenu').Show]"
		onclick = "[PdxGuiWidget.Hide]"
	}
		
	button = {
		name = "hide submenu"
		visible = no

		onclick = "[PdxGuiWidget.AccessParent.FindChild('submnenu').Hide]"
		onclick = "[PdxGuiWidget.AccessParent.FindChild('show submenu').Show]"
		onclick = "[PdxGuiWidget.Hide]"
	}

	widget = {
		name = "submenu"
		visible = no
	}
}
</pre>

If the elements are separated by more parents/children, we can repeat AccessParent like this: 
 onclick = "[PdxGuiWidget.AccessParent.AccessParent.AccessParent.AccessParent.FindChild('submnenu').Show]"

Each button can hide or reveal multiple elements of any type. You only need to provide the name.

Pros:
* easy to edit on the fly as any changes can be reloaded with the "reload gui" command

Cons:
* the toggles will reset any time the game is restarted
* If you want to hide multiple things or toggles, the code will get very bloated and hard to manage
* trying to hide entries in a data list (like a dynamicgridbox) will only hide the first instance

=== Toggles with animation ===

We can set up animations that are triggered by buttons (or conditions) to hide/show elements or to even move them. This way we don't need to count how many parents separate the button and the window and we can trigger many things at once with just one onclick.

The previous example would look like this and work the same way. The first button triggers "show_submenu", which hides the button and shows the rest, while the second button triggers "hide_submenu", which hides this button and the widget and shows the first button.

<pre>
container = {
	button = {

		state = { # this is an animation
			name = show_submenu
			on_start = "[PdxGuiWidget.Hide]"
		}
		state = {
			name = hide_submenu
			on_start = "[PdxGuiWidget.Show]"
		}

		onclick = "[PdxGuiTriggerAllAnimations('show_submenu')]"
	}
		
	button = {
		visible = no

		state = {
			name = show_submenu
			on_start = "[PdxGuiWidget.Show]"
		}
		state = {
			name = hide_submenu
			on_start = "[PdxGuiWidget.Hide]"
		}

		onclick = "[PdxGuiTriggerAllAnimations('hide_submenu')]"
	}

	widget = {
		visible = no

		state = {
			name = show_submenu
			on_start = "[PdxGuiWidget.Show]"
		}
		state = {
			name = hide_submenu
			on_start = "[PdxGuiWidget.Hide]"
		}
	}
}
</pre>

it is longer, but animations can be saved as templates and reused with one line, like <code>using = hide_animation</code>. Fullscreen Barbershop uses animations extensively, if you want a better example.

Pros:
* can also be edited on the fly, with "reload gui" command
* easier to link many things together, and even open a different window and trigger an animation in it

Cons:
* animation blocks can be quite lengthy
* all toggles will reset when the game is restarted

=== Toggles with Scripted GUIs ===

Scripted guis allows us to use script to toggle visibility. They make it easier to manage multiple things but can impact performance when used in big numbers.

For a scripted toggle we need to create a .txt file in common/scripted_guis/. The name of the file can be anything.

A basic toggle in this file would looks like this:

<pre>
gui_toggle = {
	scope = character
	
	is_shown = {
		has_variable = gui_toggle
	}
	
	effect = {
		if = {
			limit = {
				has_variable = gui_toggle
			}
			remove_variable = gui_toggle
		}
		else = {
			set_variable = gui_toggle
		}
	}
}
</pre>

When clicked, it adds a variable to the scoped character and removes it when clicked again.

Then, if the variable is present, our window will be visible. If it's not, it's hidden.

This is how the gui file would look like. We can use just one button as its function will change with each click.

<pre>
container = {
	button = {
		datacontext = "[GetScriptedGui('gui_toggle')]"
		onclick = "[ScriptedGui.Execute( GuiScope.SetRoot( GetPlayer.MakeScope ).End )]"
	}

widget = {
	datacontext = "[GetScriptedGui('gui_toggle')]"
	visible = "[ScriptedGui.IsShown( GuiScope.SetRoot( GetPlayer.MakeScope ).End )]"
	}
}
</pre>

"GetPlayer" is a global promote and returns the player character.

"Player.MakeScope" makes our player the scope of the scripted gui, meaning this is where we store the variable in.

Two buttons can be used if you want different tooltips for them. In this case, copy the 'visible' property to both buttons, but add 'Not' to one of them, so it's hidden by default:
 visible = "[Not(ScriptedGui.IsShown( GuiScope.SetRoot( GetPlayer.MakeScope ).End ))]"

Pros:
* the toggles are saved in the character and won't reset unless they die or you start a new game
* easier to link many things, even in different windows

The downsides:
* you need to restart the game to update scripted guis
* it's a little harder to remember the syntax (copy the code from here to reduce the chance of mistakes)


{{Modding navbox}}
[[Category:模组制作]]
[[en:Interface]]