Scripted effect

send_divorce_notifications_effect

send_divorce_notifications_effect = { CHARACTER = … SPOUSE = … }

game/common/scripted_effects/00_marriage_interaction_effects.txt, line 1244 (61 lines). Parameters: $CHARACTER$ , $SPOUSE$ .

send_divorce_notifications_effect is a scripted effect in Crusader Kings III, written at line 1244 of its file. A call passes 2 parameters: CHARACTER and SPOUSE. The game's script calls it in 1 place, among them on_divorce (on action). Patch 1.20.1.2, from game/common/scripted_effects/00_marriage_interaction_effects.txt.

The comment above it in the file

CHARACTER = character we check for if they should send a message
SPOUSE = the spouse in this divorce
scope:reason = flag:script or flag:faith

What it does

Every line of it is script with no tooltip text: the script is below.

The script as written (61 lines of game script)

send_divorce_notifications_effect = {
	$CHARACTER$ = {
		if = {
			limit = {
				is_ai = no
			}
			switch = {
				trigger = scope:reason
				flag:script = {
					send_interface_message = {
						type = msg_divorce
						left_icon = $SPOUSE$
					}
				}
				flag:faith = {
					send_interface_message = {
						type = msg_spouse_invalidated
						left_icon = $SPOUSE$
					}
				}
			}
		}
		else_if = {
			limit = {
				any_heir_title = {
					holder ?= { is_ai = no }
				}
			}
			every_heir_title = {
				limit = {
					holder ?= { is_ai = no }
				}
				holder = {
					if = {
						limit = {
							NOT = { is_in_list = had_notification_sent } 
						}
						add_to_list = had_notification_sent
						switch = {
							trigger = scope:reason
							flag:script = {
								send_interface_message = {
									type = msg_divorce_player_heir
									left_icon = $CHARACTER$
									right_icon = $SPOUSE$
								}
							}
							flag:faith = {
								send_interface_message = {
									type = msg_spouse_invalidated_player_heir
									left_icon = $CHARACTER$
									right_icon = $SPOUSE$
								}
							}
						}
					}
				}
			}
		}
	}
}

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

Where it is used

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

On actions (the game's own hooks) (1)

on_divorce

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