===============
LIBRARY RULES
===============
From library maintainers:
- When referencing GUI functions, prefer DATA_TYPES_INDEX.md (15,397 entries) before diving into raw logs.
- Use GUI_PATTERNS.md and QUICKSTART.md for implementation-ready snippets before constructing new examples.
- Always cite original CK3 log files (effects.log, triggers.log, etc.) when describing syntax or scopes.
- Use INFO_FILES.md to name the exact .info file path for any system the user should edit or inspect; treat .info files as the canonical source of structure and parameters.
- Confirm scope chains with GLOSSARY.md and logs/event_scopes.log before suggesting scope switches or event targets.
- Highlight cross-system interactions (effects ↔ triggers ↔ on_actions) using CROSSREFERENCE.md whenever guidance spans multiple systems.

### MultiplayerSetupWindow Functions

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_gui.txt

Functions related to the Multiplayer Setup Window, including getting default server password, hosting, and checking visibility of MP configuration.

```APIDOC
## MultiplayerSetupWindow.GetDefaultServerPassword

### Description
Retrieves the default server password for multiplayer setup.

### Method
N/A (Function call)

### Endpoint
N/A

### Return Type
CUTF8String
```

```APIDOC
## MultiplayerSetupWindow.Host

### Description
Initiates the hosting process for a multiplayer game.

### Method
N/A (Function call)

### Endpoint
N/A

### Return Type
void
```

```APIDOC
## MultiplayerSetupWindow.HostToolTip

### Description
Gets the tooltip text for the host function.

### Method
N/A (Function call)

### Endpoint
N/A

### Return Type
CString
```

```APIDOC
## MultiplayerSetupWindow.Self

### Description
Accesses the self instance of MultiplayerSetupWindow.

### Method
N/A (Function call)

### Endpoint
N/A

### Return Type
[unregistered]
```

```APIDOC
## MultiplayerSetupWindow.ShouldShowMPConfig

### Description
Determines whether the multiplayer configuration should be displayed.

### Method
N/A (Function call)

### Endpoint
N/A

### Return Type
bool
```

--------------------------------

### GetStruggleStartDate

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Gets the start date of the struggle. Returns a Date.

```APIDOC
## GetStruggleStartDate

### Description
Gets the start date of the struggle. Returns a Date.

### Parameters
-

### Return Type
Date
```

--------------------------------

### Application.Self

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_common.txt

Gets the application instance.

```APIDOC
## Application.Self

### Description
Gets the application instance.

### Return Type
[unregistered]
```

--------------------------------

### FrontEndMainView.StartGameWithChallengeCharacter

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Starts the game with the challenge character.

```APIDOC
## FrontEndMainView.StartGameWithChallengeCharacter

### Description
Starts the game with the challenge character.

### Method
Function

### Return Type
void
```

--------------------------------

### GUITrackItem.GetNextBuildingTooltip

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the tooltip for the next building.

```APIDOC
## GUITrackItem.GetNextBuildingTooltip

### Description
Gets the tooltip for the next building.

### Method
Function

### Return Type
CString
```

--------------------------------

### AchievementWindow.HasGameStarted

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_gui.txt

Checks if the game has started.

```APIDOC
## AchievementWindow.HasGameStarted

### Description
Checks if the game has started.

### Method
Function

### Return Type
bool
```

--------------------------------

### OnPlayTutorial

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Handles playing the tutorial. It takes one argument, Arg0, and returns void.

```APIDOC
## OnPlayTutorial

### Description
Handles playing the tutorial.

### Parameters
#### Path Parameters
- **Arg0** (type) - Required - Description of Arg0

### Return Type
void
```

--------------------------------

### OnStart

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Handles the start action. This function does not take any parameters and returns void.

```APIDOC
## OnStart

### Description
Handles the start action.

### Parameters
-

### Return Type
void
```

--------------------------------

### GetCurrentPhaseStartDate

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Gets the start date of the current phase. Returns a Date.

```APIDOC
## GetCurrentPhaseStartDate

### Description
Gets the start date of the current phase. Returns a Date.

### Parameters
-

### Return Type
Date
```

--------------------------------

### GUITrackItem.GetSelectedBuildingTooltip

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the tooltip for the selected building.

```APIDOC
## GUITrackItem.GetSelectedBuildingTooltip

### Description
Gets the tooltip for the selected building.

### Method
Function

### Return Type
CString
```

--------------------------------

### OnCustomStart

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Handles the custom start action. This function does not take any parameters and returns void.

```APIDOC
## OnCustomStart

### Description
Handles the custom start action.

### Parameters
-

### Return Type
void
```

--------------------------------

### GetGuestStartDelayDays

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Gets the number of delay days for guests starting an activity.

```APIDOC
## GetGuestStartDelayDays

### Description
Gets the number of delay days for guests starting an activity.

### Parameters
-

### Return Type
int32
```

--------------------------------

### GUITrackItem.GetCurrentBuildingTooltip

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the tooltip for the current building.

```APIDOC
## GUITrackItem.GetCurrentBuildingTooltip

### Description
Gets the tooltip for the current building.

### Method
Function

### Return Type
CString
```

--------------------------------

### MultiplayerSetupWindow Functions

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_gui.txt

Functions for interacting with the multiplayer setup window.

```APIDOC
## MultiplayerSetupWindow.AccessMPConfig

### Description
Provides access to the MPConfig from the setup window.

### Method
Promote

### Return Type
MPConfig
```

```APIDOC
## MultiplayerSetupWindow.GetMPConfig

### Description
Retrieves the MPConfig object from the setup window.

### Method
Promote

### Return Type
MPConfig
```

```APIDOC
## MultiplayerSetupWindow.AccessSelf

### Description
Provides access to the current MultiplayerSetupWindow instance.

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## MultiplayerSetupWindow.CanHost

### Description
Checks if the user can host a game.

### Method
Function

### Return Type
bool
```

```APIDOC
## MultiplayerSetupWindow.Cancel

### Description
Cancels the multiplayer setup process.

### Method
Function

### Return Type
void
```

```APIDOC
## MultiplayerSetupWindow.GetDefaultServerName

### Description
Gets the default server name for a new game.

### Method
Function

### Return Type
CUTF8String
```

--------------------------------

### OnShowTutorialPrompt

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Handles showing the tutorial prompt. This function does not take any parameters and returns void.

```APIDOC
## OnShowTutorialPrompt

### Description
Handles showing the tutorial prompt.

### Parameters
-

### Return Type
void
```

--------------------------------

### Get Light Properties

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Functions to get specific properties of lights.

```APIDOC
## Get Light Properties

### GetColor

Gets the color of a light.

- **Arg0** (any) - Description not provided.

### GetConeInnerAngle

Gets the inner angle of a light's cone.

- **Arg0** (any) - Description not provided.

### GetConeOuterAngle

Gets the outer angle of a light's cone.

- **Arg0** (any) - Description not provided.

### GetIntensity

Gets the intensity of a light.

- **Arg0** (any) - Description not provided.

### GetLightDescription

Gets the description of a light.

- **Arg0** (any) - Description not provided.

### GetLightIntensityVariation

Gets the intensity variation of a light.

- **Arg0** (any) - Description not provided.

### GetLightIntensityVariationFrequency

Gets the intensity variation frequency of a light.

- **Arg0** (any) - Description not provided.

### GetLightLookAt

Gets the look-at target of a light.

- **Arg0** (any) - Description not provided.
- **Arg1** (any) - Description not provided.

### GetLightPitch

Gets the pitch of a light's orientation.

- **Arg0** (any) - Description not provided.

### GetLightPosition

Gets the position of a light.

- **Arg0** (any) - Description not provided.
- **Arg1** (any) - Description not provided.

### GetLightPositionVariation

Gets the position variation of a light.

- **Arg0** (any) - Description not provided.

### GetLightPositionVariationFrequency

Gets the position variation frequency of a light.

- **Arg0** (any) - Description not provided.

### GetLightType

Gets the type of a light.

- **Arg0** (any) - Description not provided.

### GetLightYaw

Gets the yaw of a light's orientation.

- **Arg0** (any) - Description not provided.

```

--------------------------------

### BuildingLevelItem.GetTooltip

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the tooltip string for a BuildingLevelItem.

```APIDOC
## BuildingLevelItem.GetTooltip

### Description
Gets the tooltip string for a BuildingLevelItem.

### Method
Function

### Return Type
CString
```

--------------------------------

### MultiplayerSetupWindow Functions

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Functions for configuring and managing the multiplayer setup window.

```APIDOC
## MultiplayerSetupWindow Functions

### AccessMPConfig

- **Description**: Accesses the multiplayer configuration object.
- **Parameters**: None
- **Return Type**: MPConfig

### AccessSelf

- **Description**: Accesses the self object for MultiplayerSetupWindow.
- **Parameters**: None
- **Return Type**: [unregistered]

### CanHost

- **Description**: Checks if the player can host a multiplayer game.
- **Parameters**: None
- **Return Type**: bool

### Cancel

- **Description**: Cancels the multiplayer setup process.
- **Parameters**: None
- **Return Type**: void

### GetDefaultServerName

- **Description**: Gets the default server name for a multiplayer game.
- **Parameters**: None
- **Return Type**: CUTF8String

### GetDefaultServerPassword

- **Description**: Gets the default server password for a multiplayer game.
- **Parameters**: None
- **Return Type**: CUTF8String

### GetMPConfig

- **Description**: Retrieves the multiplayer configuration object.
- **Parameters**: None
- **Return Type**: MPConfig

### Host

- **Description**: Starts hosting a multiplayer game.
- **Parameters**: None
- **Return Type**: void

### HostToolTip

- **Description**: Gets the tooltip text for the host action.
- **Parameters**: None
- **Return Type**: CString

### Self

- **Description**: Returns the self object of type MultiplayerSetupWindow.
- **Parameters**: None
- **Return Type**: [unregistered]

### ShouldShowMPConfig

- **Description**: Determines if the multiplayer configuration should be displayed.
- **Parameters**: None
- **Return Type**: bool
```

--------------------------------

### Get Character Properties

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Functions to get specific properties of characters.

```APIDOC
## Get Character Properties

### GetCharacterDescription

Gets the description of a character.

- **Arg0** (any) - Description not provided.

### GetCharacterLocator

Gets the locator for a character.

- **Arg0** (any) - Description not provided.

### GetCharacterPosition

Gets the position of a character.

- **Arg0** (any) - Description not provided.
- **Arg1** (any) - Description not provided.

### GetCharacterRoles

Gets the roles of a character.

- **Arg0** (any) - Description not provided.

### GetCharacterRotation

Gets the rotation of a character.

- **Arg0** (any) - Description not provided.
- **Arg1** (any) - Description not provided.

```

--------------------------------

### Get Camera Properties

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Functions to get specific properties of cameras.

```APIDOC
## Get Camera Properties

### GetCameraDescription

Gets the description of a camera.

- **Arg0** (any) - Description not provided.

### GetCameraFar

Gets the far clipping plane of a camera.

- **Arg0** (any) - Description not provided.

### GetCameraFov

Gets the field of view of a camera.

- **Arg0** (any) - Description not provided.

### GetCameraNameLocalizationKey

Gets the localization key for a camera's name.

- **Arg0** (any) - Description not provided.

### GetCameraNear

Gets the near clipping plane of a camera.

- **Arg0** (any) - Description not provided.

### GetCameraPosition

Gets the position of a camera.

- **Arg0** (any) - Description not provided.
- **Arg1** (any) - Description not provided.

```

--------------------------------

### OnSkipTutorial

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Handles skipping the tutorial. This function does not take any parameters and returns void.

```APIDOC
## OnSkipTutorial

### Description
Handles skipping the tutorial.

### Parameters
-

### Return Type
void
```

--------------------------------

### Get Asset Properties

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Functions to get specific properties of assets.

```APIDOC
## Get Asset Properties

### GetAssetDescription

Gets the description of an asset.

- **Arg0** (any) - Description not provided.

### GetAssetLocator

Gets the locator for an asset.

- **Arg0** (any) - Description not provided.

### GetAssetName

Gets the name of an asset.

- **Arg0** (any) - Description not provided.

### GetAssetPosition

Gets the position of an asset.

- **Arg0** (any) - Description not provided.
- **Arg1** (any) - Description not provided.

### GetAssetRotation

Gets the rotation of an asset.

- **Arg0** (any) - Description not provided.
- **Arg1** (any) - Description not provided.

### GetAssetScale

Gets the scale of an asset.

- **Arg0** (any) - Description not provided.

```

--------------------------------

### GameSetup Functions and Properties

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Functions and properties for managing the game setup, including bookmarks, characters, and game state.

```APIDOC
## GameSetup.GetDlcCollection (Promote)

### Description
Retrieves the DLC collection associated with the game setup.

### Method
Promote

### Return Type
DlcCollection
```

```APIDOC
## GameSetup.GetHoveredCharacter (Promote)

### Description
Retrieves the character currently being hovered over in the game setup.

### Method
Promote

### Return Type
BookmarkCharacter
```

```APIDOC
## GameSetup.GetSelectedBookmark (Promote)

### Description
Retrieves the currently selected bookmark in the game setup.

### Method
Promote

### Return Type
Bookmark
```

```APIDOC
## GameSetup.GetSelectedBookmarkGroup (Promote)

### Description
Retrieves the currently selected bookmark group in the game setup.

### Method
Promote

### Return Type
BookmarkGroup
```

```APIDOC
## GameSetup.GetSelectedCharacter (Promote)

### Description
Retrieves the currently selected character in the game setup.

### Method
Promote

### Return Type
BookmarkCharacter
```

```APIDOC
## GameSetup.GetSelectedDate (Promote)

### Description
Retrieves the currently selected date in the game setup.

### Method
Promote

### Return Type
Date
```

```APIDOC
## GameSetup.AccessBookmarkGroups

### Description
Provides access to bookmark groups within the game setup.

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## GameSetup.AccessSelf

### Description
Provides access to the current game setup instance.

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## GameSetup.CanStart

### Description
Checks if the game can be started based on the current setup.

### Method
Function

### Return Type
bool
```

```APIDOC
## GameSetup.ClearSelectedBookmarkGroup

### Description
Clears the currently selected bookmark group in the game setup.

### Method
Function

### Return Type
void
```

```APIDOC
## GameSetup.CustomPlayTooltip

### Description
Generates a custom tooltip for play-related actions in the game setup.

### Method
Function

### Return Type
CString
```

```APIDOC
## GameSetup.DeselectHoveredBookmarkCharacter

### Description
Deselects the character that is currently being hovered over.

### Method
Function

### Return Type
void
```

```APIDOC
## GameSetup.GetBookmarkDescription

### Description
Retrieves the description of a bookmark.

### Method
Function

### Return Type
CString
```

```APIDOC
## GameSetup.GetBookmarkName

### Description
Retrieves the name of a bookmark.

### Method
Function

### Return Type
CString
```

```APIDOC
## GameSetup.GetBookmarksInGroup( Arg0 )

### Description
Retrieves bookmarks within a specified group.

### Parameters
#### Path Parameters
- **Arg0** (unknown) - Required - Description not specified

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## GameSetup.GetDlcCollection

### Description
Retrieves the DLC collection associated with the game setup.

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## GameSetup.GetHoveredCharacter

### Description
Retrieves the character currently being hovered over in the game setup.

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## GameSetup.GetSelectedBookmark

### Description
Retrieves the currently selected bookmark in the game setup.

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## GameSetup.GetSelectedBookmarkCharacters

### Description
Retrieves the characters associated with the selected bookmark.

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## GameSetup.GetSelectedBookmarkGroup

### Description
Retrieves the currently selected bookmark group in the game setup.

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## GameSetup.GetSelectedCharacter

### Description
Retrieves the currently selected character in the game setup.

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## GameSetup.GetSelectedDate

### Description
Retrieves the currently selected date in the game setup.

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## GameSetup.GetTutorialCharacters

### Description
Retrieves characters available for tutorials in the game setup.

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## GameSetup.GetUngroupedBookmarks

### Description
Retrieves bookmarks that are not currently assigned to any group.

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## GameSetup.HasGameStarted

### Description
Checks if the game has already started.

### Method
Function

### Return Type
[unregistered]
```

--------------------------------

### SuccessionEventWindow.GoToObserver

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Navigates to the observer mode.

```APIDOC
## SuccessionEventWindow.GoToObserver

### Description
Navigates the user to the observer mode. This function allows viewing the game without direct control.

### Method
Function

### Return Type
void
```

--------------------------------

### Get Artifact Properties

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Functions to get specific properties of artifacts.

```APIDOC
## Get Artifact Properties

### GetArtifactDescription

Gets the description of an artifact.

- **Arg0** (any) - Description not provided.

### GetArtifactDescriptionOrSlot

Gets the description or slot of an artifact.

- **Arg0** (any) - Description not provided.

### GetArtifactLocator

Gets the locator for an artifact.

- **Arg0** (any) - Description not provided.

### GetArtifactPosition

Gets the position of an artifact.

- **Arg0** (any) - Description not provided.
- **Arg1** (any) - Description not provided.

### GetArtifactRotation

Gets the rotation of an artifact.

- **Arg0** (any) - Description not provided.
- **Arg1** (any) - Description not provided.

### GetArtifactSlotType

Gets the slot type of an artifact.

- **Arg0** (any) - Description not provided.

```

--------------------------------

### Get Static Hovered Object Position

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Gets the position of the statically hovered object.

```APIDOC
## GetStaticHoveredObjectPosition

### Description
Retrieves the screen or world position of an object that is currently being statically hovered over.

### Method
Function

### Parameters
- **Arg0** (any): An argument, possibly related to the object or context.

### Response
#### Success Response
- `CVector2f`: A 2D float vector representing the position.
```

--------------------------------

### StartGame

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Initiates the game start process. This function does not take any parameters and has a type of 'Type'.

```APIDOC
## StartGame

### Description
Initiates the game start process.

### Parameters
-

### Return Type
Type
```

--------------------------------

### Other Scope Examples

Source: https://github.com/nonniks/ck3_documentation/blob/main/GLOSSARY.md

Provides examples of switching to other relevant scopes like dynasty, activity, or scheme.

```plaintext
dynasty = { } - Switch to dynasty scope (from character)
activity = { } - Switch to activity scope (if available)
scheme = { } - Switch to scheme scope (if available)
```

--------------------------------

### Get General Properties

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Functions to get general properties like pitch, radius, and shadow settings.

```APIDOC
## Get General Properties

### GetPitch

Gets the pitch of an object.

- **Arg0** (any) - Description not provided.

### GetRadius

Gets the radius of an object.

- **Arg0** (any) - Description not provided.

### GetShadowFade

Gets the shadow fade value for an object.

- **Arg0** (any) - Description not provided.

### GetToolset

Retrieves the court toolset.

### GetYaw

Gets the yaw of an object.

- **Arg0** (any) - Description not provided.

```

--------------------------------

### GameMpSetup Functions

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Functions for managing multiplayer game setup and visibility.

```APIDOC
## GameMpSetup.OnStart

### Description
Function to handle the start of a multiplayer game setup.

### Method
Function

### Return Type
void
```

```APIDOC
## GameMpSetup.Self

### Description
Access to the current multiplayer game setup instance.

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## GameMpSetup.SetVisibilityInvite

### Description
Sets the visibility for invite-only multiplayer games.

### Method
Function

### Return Type
void
```

```APIDOC
## GameMpSetup.SetVisibilityPublicCrossplay

### Description
Sets the visibility for public multiplayer games with crossplay enabled.

### Method
Function

### Return Type
void
```

```APIDOC
## GameMpSetup.SetVisibilityPublicNoCrossplay

### Description
Sets the visibility for public multiplayer games without crossplay.

### Method
Function

### Return Type
void
```

```APIDOC
## GameMpSetup.StartTooltip

### Description
Starts a tooltip related to multiplayer setup.

### Method
Function

### Return Type
CString
```

```APIDOC
## GameMpSetup.ToggleAutoAccept

### Description
Toggles the auto-accept setting for multiplayer invites or game starts.

### Method
Function

### Return Type
void
```

```APIDOC
## GameMpSetup.ToggleVisibility

### Description
Toggles the general visibility setting for multiplayer games.

### Method
Function

### Return Type
void
```

--------------------------------

### TravelPlanner.StartTravelPlan

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Initiates the start of a travel plan.

```APIDOC
## TravelPlanner.StartTravelPlan

### Description
Initiates the start of a travel plan.

### Definition type
Function

### Return type
void
```

--------------------------------

### TutorialWindow Functions

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Functions for interacting with the Tutorial Window.

```APIDOC
## TutorialWindow.AccessSelf

### Description
Provides access to the TutorialWindow instance.

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## TutorialWindow.Close

### Description
Closes the tutorial window.

### Method
Function

### Return Type
void
```

```APIDOC
## TutorialWindow.Self

### Description
Accesses the self instance of the TutorialWindow.

### Method
Function

### Return Type
[unregistered]
```

--------------------------------

### Character Data Type Example

Source: https://github.com/nonniks/ck3_documentation/blob/main/GUI_PATTERNS.md

Examples of common functions and their return types for the Character data type, found in Character.txt.

```text
GetAge -> int32
IsAlive -> bool
GetGold -> fixed_point
```

--------------------------------

### Tutorial Functions

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Functions for interacting with tutorials, including checking replayability, getting step and transition information, and enabling/disabling transitions.

```APIDOC
## Tutorial.AccessSelf

### Description
Accesses the self instance.

### Method
Function

### Return Type
[unregistered]
```

```APIDOC
## Tutorial.CanReplayVoiceover

### Description
Checks if the tutorial voiceover can be replayed.

### Method
Function

### Return Type
bool
```

```APIDOC
## Tutorial.GetReplayVoiceoverTooltip

### Description
Retrieves the tooltip for replaying the tutorial voiceover.

### Method
Function

### Return Type
CString
```

```APIDOC
## Tutorial.GetStepHeaderInfo

### Description
Retrieves header information for the current tutorial step.

### Method
Function

### Return Type
CString
```

```APIDOC
## Tutorial.GetStepInstructions

### Description
Retrieves the instructions for the current tutorial step.

### Method
Function

### Return Type
CString
```

```APIDOC
## Tutorial.GetStepName

### Description
Retrieves the name of the current tutorial step.

### Method
Function

### Return Type
CString
```

```APIDOC
## Tutorial.GetStepText

### Description
Retrieves the text content for the current tutorial step.

### Method
Function

### Return Type
CString
```

```APIDOC
## Tutorial.GetTransitionText

### Description
Retrieves the text for a tutorial transition.

### Method
Function

### Parameters
- **Arg0** (unknown) - Description not available

### Return Type
CString
```

```APIDOC
## Tutorial.GetTransitionTooltip

### Description
Retrieves the tooltip for a tutorial transition.

### Method
Function

### Parameters
- **Arg0** (unknown) - Description not available

### Return Type
CString
```

```APIDOC
## Tutorial.HasStepInstructions

### Description
Checks if the current tutorial step has instructions.

### Method
Function

### Return Type
bool
```

```APIDOC
## Tutorial.HasTransition

### Description
Checks if a tutorial transition exists.

### Method
Function

### Parameters
- **Arg0** (unknown) - Description not available

### Return Type
bool
```

```APIDOC
## Tutorial.IsTransitionEnabled

### Description
Checks if a tutorial transition is enabled.

### Method
Function

### Parameters
- **Arg0** (unknown) - Description not available

### Return Type
bool
```

--------------------------------

### Access and Get Character Variable

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Allows access to a character's scope to get the value of a specific variable. Ensure the variable name is correctly specified.

```script
[Character.MakeScope.Var('variable_name').GetValue]
```

--------------------------------

### EventTargetSetupContext

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_internalclausewitzgui.txt

Context for setting up event targets.

```APIDOC
## EventTargetSetupContext

### Description
Context for setting up event targets.

### Functions
- **AccessSelf**(): Returns an unregistered type.
- **AccessVariableLists**(): Returns a VariableListStore.
- **AccessVariables**(): Returns a VariableStore.
- **Self**(): Returns an unregistered type.
```

--------------------------------

### SuccessionEventWindow.GetHeirDesc

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the description of the heir.

```APIDOC
## SuccessionEventWindow.GetHeirDesc

### Description
Returns a descriptive string for the heir. This provides details about the designated heir.

### Method
Function

### Return Type
CString
```

--------------------------------

### SuccessionEventWindow.GoToMenu

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Navigates to the main menu.

```APIDOC
## SuccessionEventWindow.GoToMenu

### Description
Navigates the user to the main menu of the application. This function closes the current window and opens the main menu.

### Method
Function

### Return Type
void
```

--------------------------------

### LegendType.GetName

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the name of a LegendType.

```APIDOC
## LegendType.GetName

### Description
Gets the name of a LegendType.

### Method
Function

### Return Type
CString
```

--------------------------------

### LegendSeed.GetName

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the name of a LegendSeed.

```APIDOC
## LegendSeed.GetName( Arg0 )

### Description
Gets the name of a LegendSeed.

### Method
Function

### Parameters
#### Path Parameters
- **Arg0** (type) - Required - Description

### Return Type
CString
```

--------------------------------

### GetTutorial

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Retrieves tutorial information.

```APIDOC
## GetTutorial

### Description
Retrieves information related to the tutorial.

### Method
GET

### Endpoint
/tutorial

### Return Type
Tutorial
```

--------------------------------

### LegendSeed.GetDescription

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the description of a LegendSeed.

```APIDOC
## LegendSeed.GetDescription( Arg0 )

### Description
Gets the description of a LegendSeed.

### Method
Function

### Parameters
#### Path Parameters
- **Arg0** (type) - Required - Description

### Return Type
CString
```

--------------------------------

### ReturnToMenu

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Returns the player to the main menu.

```APIDOC
## ReturnToMenu

### Description
Returns the player to the main menu.

### Method
Global function

### Return Type
void
```

--------------------------------

### Hook.GetName

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the name of a Hook.

```APIDOC
## Hook.GetName

### Description
Gets the name of a Hook.

### Method
Function

### Return Type
CString
```

--------------------------------

### StartPhasePlanning

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Begins the phase planning process for the activity.

```APIDOC
## StartPhasePlanning

### Description
Begins the phase planning process for the activity.

### Parameters
-

### Return Type
void
```

--------------------------------

### Character.GetStartCouncilTaskInTooltip

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Retrieves a tooltip for starting a council task.

```APIDOC
## Character.GetStartCouncilTaskInTooltip( Arg0, Arg1 )

### Description
Retrieves a tooltip for starting a council task.

### Method
Function

### Parameters
#### Path Parameters
- **Arg0** (type) - Required - Description of the first argument
- **Arg1** (type) - Required - Description of the second argument

### Return Type
CString
```

--------------------------------

### DynastyPerk.GetName

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the name of the perk.

```APIDOC
## DynastyPerk.GetName

### Description
Gets the name of the perk.

### Function Signature
DynastyPerk.GetName()

### Return Type
CString
```

--------------------------------

### FrontEndMainView.OnSettings

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Handles the settings event.

```APIDOC
## FrontEndMainView.OnSettings

### Description
Handles the settings event.

### Method
Function

### Return Type
void
```

--------------------------------

### DynastyLegacy.GetName

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the name of the legacy.

```APIDOC
## DynastyLegacy.GetName

### Description
Gets the name of the legacy.

### Function Signature
DynastyLegacy.GetName()

### Return Type
CString
```

--------------------------------

### CombatWindow.GoToProvince

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Navigates the view to the province where the combat is taking place.

```APIDOC
## CombatWindow.GoToProvince

### Description
Navigates the view to the province where the combat is taking place.

### Method
Function

### Return Type
void
```

--------------------------------

### DynastyLegacy.GetIcon

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the icon for the legacy.

```APIDOC
## DynastyLegacy.GetIcon

### Description
Gets the icon for the legacy.

### Function Signature
DynastyLegacy.GetIcon()

### Return Type
[unregistered]
```

--------------------------------

### DynastyLegacy.GetDesc

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the description of the legacy.

```APIDOC
## DynastyLegacy.GetDesc

### Description
Gets the description of the legacy.

### Function Signature
DynastyLegacy.GetDesc()

### Return Type
CString
```

--------------------------------

### HybridizationWindow.GetRightNamingExamples

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Retrieves naming examples for the right side in the HybridizationWindow.

```APIDOC
## HybridizationWindow.GetRightNamingExamples

### Description
Retrieves naming examples for the right side in the HybridizationWindow.

### Method
Function

### Return Type
CString
```

--------------------------------

### Culture.GetHeritage

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the heritage of a culture.

```APIDOC
## Culture.GetHeritage

### Description
Retrieves the heritage or ancestral origin of a culture.

### Function Signature
Culture.GetHeritage()

### Return Type
[unregistered]
```

--------------------------------

### Tutorial Functions

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Provides access to functions for controlling and querying tutorial states.

```APIDOC
## Tutorial Functions

### AccessSelf

- **Description**: Accesses the self-reference of the Tutorial object.
- **Parameters**: None
- **Return Type**: [unregistered]

### CanReplayVoiceover

- **Description**: Checks if the tutorial voiceover can be replayed.
- **Parameters**: None
- **Return Type**: bool

### GetReplayVoiceoverTooltip

- **Description**: Retrieves the tooltip text for replaying the voiceover.
- **Parameters**: None
- **Return Type**: CString

### GetStepHeaderInfo

- **Description**: Retrieves header information for the current tutorial step.
- **Parameters**: None
- **Return Type**: CString

### GetStepInstructions

- **Description**: Retrieves the instructions for the current tutorial step.
- **Parameters**: None
- **Return Type**: CString

### GetStepName

- **Description**: Retrieves the name of the current tutorial step.
- **Parameters**: None
- **Return Type**: CString

### GetStepText

- **Description**: Retrieves the text content for the current tutorial step.
- **Parameters**: None
- **Return Type**: CString

### GetTransitionText

- **Description**: Retrieves the text for a tutorial transition.
- **Parameters**: Arg0 (type unknown)
- **Return Type**: CString

### GetTransitionTooltip

- **Description**: Retrieves the tooltip text for a tutorial transition.
- **Parameters**: Arg0 (type unknown)
- **Return Type**: CString

### HasStepInstructions

- **Description**: Checks if the current tutorial step has instructions.
- **Parameters**: None
- **Return Type**: bool

### HasTransition

- **Description**: Checks if a tutorial transition exists.
- **Parameters**: Arg0 (type unknown)
- **Return Type**: bool

### IsTransitionEnabled

- **Description**: Checks if a tutorial transition is enabled.
- **Parameters**: Arg0 (type unknown)
- **Return Type**: bool

### OnClickTransition

- **Description**: Handles the click event for a tutorial transition.
- **Parameters**: Arg0 (type unknown)
- **Return Type**: void

### ReplayVoiceover

- **Description**: Replays the tutorial voiceover.
- **Parameters**: None
- **Return Type**: void

### Self

- **Description**: Accesses the self-reference of the Tutorial object.
- **Parameters**: None
- **Return Type**: [unregistered]

### ShouldBeVisible

- **Description**: Checks if the tutorial element should be visible.
- **Parameters**: None
- **Return Type**: bool
```

--------------------------------

### Culture.GetEthos

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the ethos of a culture.

```APIDOC
## Culture.GetEthos

### Description
Retrieves the primary ethos or guiding principles of a culture.

### Function Signature
Culture.GetEthos()

### Return Type
[unregistered]
```

--------------------------------

### County.GetName

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the name of the county.

```APIDOC
## County.GetName

### Description
Gets the name of the county.

### Function Signature
County.GetName()

### Return Type
CString
```

--------------------------------

### Character.StartPromotingLegend

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Starts promoting a legend associated with the character.

```APIDOC
## Character.StartPromotingLegend

### Description
Starts promoting a legend associated with the character.

### Method
Function

### Parameters
#### Path Parameters
- **Arg0** (any) - Required - The legend to promote.

### Return Type
Command
```

--------------------------------

### EntityEditorKeyframe.Label

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_internalclausewitzgui.txt

Gets the label of the keyframe.

```APIDOC
## EntityEditorKeyframe.Label

### Description
Gets the label of the keyframe.

### Method
Function

### Return Type
CString
```

--------------------------------

### GUITrackItem.GoBack

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Navigates back.

```APIDOC
## GUITrackItem.GoBack

### Description
Navigates back.

### Method
Function

### Return Type
void
```

--------------------------------

### EntityViewerProperties.SelectEnvWindow

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_internalclausewitzgui.txt

Opens the environment selection window.

```APIDOC
## EntityViewerProperties.SelectEnvWindow

### Description
Opens the environment selection window.

### Method
Function

### Return Type
void
```

--------------------------------

### EntityEditorKeyframe.KeyframeColor

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_internalclausewitzgui.txt

Gets the color of the keyframe.

```APIDOC
## EntityEditorKeyframe.KeyframeColor

### Description
Gets the color of the keyframe.

### Method
Function

### Return Type
CVector4f
```

--------------------------------

### CPdxIntRect.Self

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_common.txt

Gets the CPdxIntRect instance.

```APIDOC
## CPdxIntRect.Self

### Description
Gets the CPdxIntRect instance.

### Return Type
[unregistered]
```

--------------------------------

### JominiNotification.SetupDataContexts

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_gui.txt

Sets up data contexts for a JominiNotification. Requires one argument.

```APIDOC
## JominiNotification.SetupDataContexts

### Description
Sets up data contexts for a JominiNotification. Requires one argument.

### Method
Promote

### Parameters
#### Path Parameters
- **Arg0** (type) - Required - Description of the argument

### Return Type
NotificationDummyContext
```

--------------------------------

### CPdxFloatRect.Self

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_common.txt

Gets the CPdxFloatRect instance.

```APIDOC
## CPdxFloatRect.Self

### Description
Gets the CPdxFloatRect instance.

### Return Type
[unregistered]
```

--------------------------------

### Character.StartPlanningGreatProject

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Initiates the planning phase for a great project.

```APIDOC
## Character.StartPlanningGreatProject

### Description
Initiates the planning phase for a great project.

### Method
Function

### Parameters
#### Path Parameters
- **Arg0** (any) - Required - Argument related to the great project.
- **Arg1** (any) - Required - Argument for planning.

### Return Type
Command
```

--------------------------------

### CFixedPoint.Self

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_common.txt

Gets the CFixedPoint instance.

```APIDOC
## CFixedPoint.Self

### Description
Gets the CFixedPoint instance.

### Return Type
[unregistered]
```

--------------------------------

### CopyBuildVersionInfoToClipboard

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Copies the build version information to the clipboard. Returns void.

```APIDOC
## CopyBuildVersionInfoToClipboard

### Description
Copies the build version information to the clipboard.

### Return Type
void
```

--------------------------------

### TitleViewWindow.GoToHolding

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Navigates to the holding.

```APIDOC
## TitleViewWindow.GoToHolding

### Description
Navigates to the holding.

### Function Signature
`TitleViewWindow.GoToHolding()`

### Return Type
void
```

--------------------------------

### Title Scope Examples

Source: https://github.com/nonniks/ck3_documentation/blob/main/GLOSSARY.md

Shows how to switch scope to different titles and their holders.

```plaintext
primary_title = { } - Switch to character's main title scope
holder = { } - Switch from title to its holder (character)
```

--------------------------------

### SuccessionEventWindow.GetPlayedLength

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the total duration of playtime.

```APIDOC
## SuccessionEventWindow.GetPlayedLength

### Description
Retrieves the total duration of playtime. This function returns a string representing the accumulated playtime.

### Method
Function

### Return Type
CString
```

--------------------------------

### GovernmentAdministrationWindow.GetAllThemes

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Retrieves all available themes.

```APIDOC
## GovernmentAdministrationWindow.GetAllThemes

### Description
Retrieves a list of all available themes.

### Method
Function

### Return Type
[unregistered]
```

--------------------------------

### GameMpSetup Functions

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Functions related to multiplayer game setup and configuration.

```APIDOC
## GameMpSetup Functions

### AccessSelf

- **Parameters**: -
- **Return Type**: `[unregistered]`
- **Definition Type**: `Function`

### CanStart

- **Parameters**: -
- **Return Type**: `bool`
- **Definition Type**: `Function`

### GetBookmarkDescription

- **Parameters**: -
- **Return Type**: `CString`
- **Definition Type**: `Function`

### GetBookmarkItems

- **Parameters**: -
- **Return Type**: `[unregistered]`
- **Definition Type**: `Function`

### GetEnabledDLCs

- **Parameters**: -
- **Return Type**: `[unregistered]`
- **Definition Type**: `Function`

### GetEnabledMods

- **Parameters**: -
- **Return Type**: `[unregistered]`
- **Definition Type**: `Function`

### GetSaveGames

- **Parameters**: -
- **Return Type**: `[unregistered]`
- **Definition Type**: `Function`

### GetSelectedBookmark

- **Parameters**: -
- **Return Type**: `MpBookmarkItem`
- **Definition Type**: `Promote`

### GetSelectedSaveGame

- **Parameters**: -
- **Return Type**: `SaveGameItem`
- **Definition Type**: `Promote`

### GetSelectedStartDate

- **Parameters**: -
- **Return Type**: `Date`
- **Definition Type**: `Promote`

### IsAutoAccept

- **Parameters**: -
- **Return Type**: `bool`
- **Definition Type**: `Function`

### IsBookmarkSelected

- **Parameters**: -
- **Return Type**: `bool`
- **Definition Type**: `Function`

### IsInvite

- **Parameters**: -
- **Return Type**: `bool`
- **Definition Type**: `Function`

### IsPublicCrossplay

- **Parameters**: -
- **Return Type**: `bool`
- **Definition Type**: `Function`

### IsPublicNoCrossplay

- **Parameters**: -
- **Return Type**: `bool`
- **Definition Type**: `Function`

### IsSaveGameSelected

- **Parameters**: -
- **Return Type**: `bool`
- **Definition Type**: `Function`

### IsShowInvalidSavegames

- **Parameters**: -
- **Return Type**: `bool`
- **Definition Type**: `Function`

### OnBack

- **Parameters**: -
- **Return Type**: `void`
- **Definition Type**: `Function`

### OnDelete

- **Parameters**: -
- **Return Type**: `void`
- **Definition Type**: `Function`

### OnStart

- **Parameters**: -
- **Return Type**: `void`
- **Definition Type**: `Function`

### Self

- **Parameters**: -
- **Return Type**: `[unregistered]`
- **Definition Type**: `Function`

### SetVisibilityInvite

- **Parameters**: -
- **Return Type**: `void`
- **Definition Type**: `Function`

### SetVisibilityPublicCrossplay

- **Parameters**: -
- **Return Type**: `void`
- **Definition Type**: `Function`

### SetVisibilityPublicNoCrossplay

- **Parameters**: -
- **Return Type**: `void`
- **Definition Type**: `Function`

### StartTooltip

- **Parameters**: -
- **Return Type**: `CString`
- **Definition Type**: `Function`

### ToggleAutoAccept

- **Parameters**: -
- **Return Type**: `void`
- **Definition Type**: `Function`

### ToggleVisibility

- **Parameters**: -
- **Return Type**: `void`
- **Definition Type**: `Type`
```

--------------------------------

### SuccessionEventWindow.GetExitName

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the name displayed when exiting.

```APIDOC
## SuccessionEventWindow.GetExitName

### Description
Retrieves the name associated with the exit action or option. This is the text shown to the user when they choose to exit.

### Method
Function

### Return Type
CString
```

--------------------------------

### Standard Event Pipeline in CK3

Source: https://context7.com/nonniks/ck3_documentation/llms.txt

Illustrates the sequence of operations in a standard CK3 event, from On_Action firing to effect execution after player choice.

```txt
# Standard event pipeline
On_Action fires (e.g. on_character_birth)
    → trigger block checked (e.g. is_ruler = yes)
    → Event fires if trigger passes
    → immediate block runs (no player choice)
    → option blocks presented
    → chosen option's effects execute
```

--------------------------------

### SuccessionEventWindow.GetDeadDesc

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the description of a dead character.

```APIDOC
## SuccessionEventWindow.GetDeadDesc

### Description
Returns a descriptive string for a dead character. This provides a textual summary of the character's status or history.

### Method
Function

### Return Type
CString
```

--------------------------------

### RulerDesignerWindow.GetBirthYear

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the birth year of the ruler.

```APIDOC
## RulerDesignerWindow.GetBirthYear

### Description
Gets the birth year of the ruler.

### Method
Function

### Return Type
int32
```

--------------------------------

### HybridizationWindow.GetLeftNamingExamples

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Retrieves naming examples for the left side in the HybridizationWindow.

```APIDOC
## HybridizationWindow.GetLeftNamingExamples

### Description
Retrieves naming examples for the left side in the HybridizationWindow.

### Method
Function

### Return Type
CString
```

--------------------------------

### RulerDesignerWindow.GetAge

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the current age of the ruler.

```APIDOC
## RulerDesignerWindow.GetAge

### Description
Gets the current age of the ruler.

### Method
Function

### Return Type
int32
```

--------------------------------

### StartEditingOption

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Initiates editing for a specific activity option.

```APIDOC
## StartEditingOption

### Description
Initiates editing for a specific activity option.

### Parameters
- **Arg0** (type) - Required - Description

### Return Type
void
```

--------------------------------

### MenAtArmsTypeView.Self

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the self reference for MenAtArmsTypeView.

```APIDOC
## MenAtArmsTypeView.Self

### Description
Gets the self reference for MenAtArmsTypeView.

### Function Signature
MenAtArmsTypeView.Self()

### Return Type
[unregistered]
```

--------------------------------

### OpenAppointWindow

Source: https://github.com/nonniks/ck3_documentation/blob/main/DATA_TYPES_INDEX.md

Opens the appointment window for a given argument. Returns void.

```APIDOC
## OpenAppointWindow

### Description
Opens the appointment window.

### Parameters
#### Path Parameters
- **Arg0** (any) - Required - The argument to open the window for.

### Return Type
void
```

--------------------------------

### MenAtArmsType.Self

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the self reference for MenAtArmsType.

```APIDOC
## MenAtArmsType.Self

### Description
Gets the self reference for MenAtArmsType.

### Function Signature
MenAtArmsType.Self()

### Return Type
[unregistered]
```

--------------------------------

### HybridizationWindow.GetVassalConversionWindow (Promote)

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Retrieves the Vassal Conversion Window associated with the HybridizationWindow.

```APIDOC
## HybridizationWindow.GetVassalConversionWindow (Promote)

### Description
Retrieves the Vassal Conversion Window associated with the HybridizationWindow.

### Method
Promote

### Return Type
VassalConversionWindow
```

--------------------------------

### LegendSeed.GetMaintenanceCost

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the maintenance cost of a LegendSeed.

```APIDOC
## LegendSeed.GetMaintenanceCost( Arg0 )

### Description
Gets the maintenance cost of a LegendSeed.

### Method
Function

### Parameters
#### Path Parameters
- **Arg0** (type) - Required - Description

### Return Type
[unregistered]
```

--------------------------------

### LegendSeed.GetImpactModifiers

Source: https://github.com/nonniks/ck3_documentation/blob/main/logs/data_types/data_types_uncategorized.txt

Gets the impact modifiers of a LegendSeed.

```APIDOC
## LegendSeed.GetImpactModifiers( Arg0 )

### Description
Gets the impact modifiers of a LegendSeed.

### Method
Function

### Parameters
#### Path Parameters
- **Arg0** (type) - Required - Description

### Return Type
CString
```