CK3 DatabaseCrusader Kings III · 1.20.1.2 “Crozier” · unofficial
Silk & Silverout Tue, Nov 17What's free, what needs the DLC, price →

Scripted effect · All Under Heaven files

tgp_renounce_estate_effect

tgp_renounce_estate_effect = yes

game/common/scripted_effects/10_dlc_tgp_japan_scripted_effects.txt, line 3828 (177 lines). No parameters.

tgp_renounce_estate_effect is a scripted effect in Crusader Kings III, in the All Under Heaven files, written at line 3828 of its file. It takes no parameters: tgp_renounce_estate_effect = yes. The game's script calls it in 3 places, among them In Search of the Pure Land (decision), A New Walk of Life (event tgp_japan_decision.9500) and Retire from Heading the … House (event tgp_dynastic_cycle_decision_event.0101). Its body carries 2 texts of the game's own for the player. Patch 1.20.1.2, from game/common/scripted_effects/10_dlc_tgp_japan_scripted_effects.txt.

What it does

• the game's own tooltip text · ◦ our reading of the script line · code the script where neither exists

“They” is whatever it runs on (the scope it is called in). The scripted triggers and effects it calls link to their own pages; $PARAMETERS$ stay as written: each call fills them in.

The script as written (120 lines of game script)
tgp_renounce_estate_effect = {
	save_scope_as = retired
	random_held_title = {
		limit = { is_noble_family_title = yes }
		current_heir = { 
			save_scope_as = new_player
			if = {
				limit = { scope:retired = { is_ai = no } }
				save_scope_as = new_human_player_character
			}
		}
	}
	if = {
		limit = {
			NOT = { exists = scope:new_player }
		}
		player_heir ?= {
			save_scope_as = new_player
			if = {
				limit = { scope:retired = { is_ai = no } }
				save_scope_as = new_human_player_character
			}
		}
	}
	add_character_modifier = { modifier = ep3_renounced_estate }
	custom_tooltip = {
		text = renounce_noble_family_title_decision_tt
		send_interface_toast = {
			type = event_toast_effect_neutral
			title = renounce_noble_family_title_decision_toast_title
			custom_tooltip = renounce_noble_family_title_decision_toast_desc
			left_icon = scope:new_player
			right_icon = this
		}
	}
	if = {
		limit = {
			NOT = { has_trait = devoted }
		}
		add_trait = devoted
	}
	# TODO TIT-74285 use clean depose = yes after abdication also subjected to admin_allows_holding_multiple_primary_tier_titles
	if = {
		limit = { exists = scope:new_player }
		hidden_effect = {
			scope:new_player ?= {
				set_variable = {
					name = previous_holder_grandeur_value
					value = prev.court_grandeur_current
				}
			}
			create_title_and_vassal_change = {
				type = granted
				save_scope_as = title_change
				add_claim_on_loss = no
			}
			if = {
				limit = { is_governor = no }
				every_held_title = {
					limit = { tier > tier_barony }
					change_title_holder_include_vassals = {
						holder = scope:new_player
						change = scope:title_change
					}
				}
				# pass all artifacts away
				every_character_artifact = {
					if = {
						limit = { is_equipped = yes }
						add_to_list = equipped
					}
					set_owner = {
						target = scope:new_player
						history = {
							type = inherited
							recipient = scope:new_player
						}
					}
				}
			}
			else = {
				# pass the artifact if it's binded to NF (should not happen in vanilla tho), take from others title or not binded to a title
				every_character_artifact = {
					limit = {
						trigger_if = {
							limit = { has_variable = artifact_succession_title }
							OR = {
								var:artifact_succession_title.holder ?= { this != scope:retired }
								var:artifact_succession_title ?= { is_noble_family_title = yes }
							}
						}
					}
					if = {
						limit = { is_equipped = yes }
						add_to_list = equipped
					}
					set_owner = {
						target = scope:new_player
						history = {
							type = inherited
							recipient = scope:new_player
						}
					}
				}
				every_held_title = {
					limit = { is_noble_family_title = yes }
					change_title_holder = {
						holder = scope:new_player
						change = scope:title_change
					}
				}
			}
			resolve_title_and_vassal_change = scope:title_change
			if = {
				limit = { is_ruler = yes }
				primary_title.current_heir = { save_scope_as = heir_temp }
				# now handle title succession
				every_character_artifact = {
					limit = { var:artifact_succession_title.holder ?= scope:retired }
					if = {

As written in game/common/scripted_effects/10_dlc_tgp_japan_scripted_effects.txt.

The first 120 of its 177 lines; the rest is in game/common/scripted_effects/10_dlc_tgp_japan_scripted_effects.txt from line 3828.

Where it is used

Every place in common/, events/ and history/ that calls tgp_renounce_estate_effect.

Events (2)

Source: game/common/scripted_effects/10_dlc_tgp_japan_scripted_effects.txt and every file of common/, events/ and history/ that calls it, Crusader Kings III 1.20.1.2.

Spotted a mistake on this page?