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

Scripted effect

return_ward_travel_effect

return_ward_travel_effect = yes

game/common/scripted_effects/00_education_effects.txt, line 2090 (36 lines). No parameters.

return_ward_travel_effect is a scripted effect in Crusader Kings III, written at line 2090 of its file. It takes no parameters: return_ward_travel_effect = yes. The game's script calls it in 2 places, among them remove_guardian_effect (scripted effect) and wrap_up_education_effect (scripted effect). Patch 1.20.1.2, from game/common/scripted_effects/00_education_effects.txt.

What it does

  • If

    • is_foreign_court_guest = yes
    • host != liege

    Then

    • return_to_court = yes

• 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 (36 lines of game script)
return_ward_travel_effect = {
	if = {
		limit = {
			is_foreign_court_guest = yes
			exists = liege
			host != liege
		}
		show_as_tooltip = { return_to_court = yes }
		location ?= { save_scope_as = starting_location }
		if = {
			limit = { exists = scope:educator }
			set_variable = {
				name = guardian_educated
				value = scope:educator
				years = 3
			}
			set_variable = {
				name = guardian_educated_realm
				value = host.primary_title
				years = 3
			}
		}
		# Actually return guardian last
		hidden_effect = {
			set_location = scope:starting_location
			start_travel_plan = {
				destination = liege.capital_province
				on_start_on_action = on_ward_depart_for_home
				on_travel_planner_cancel_on_action = on_ward_depart_travel_planner_exit
				on_arrival_on_action = on_ward_arrive_at_home
				on_arrival_destinations = last
				return_trip = no # One way
			}
		}
	}
}

As written in game/common/scripted_effects/00_education_effects.txt.

Where it is used

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

Source: game/common/scripted_effects/00_education_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?