# Localization Formatters

## Table of Content

* [advisor_desc](#advisor_desc)
* [building_state_modifier](#building_state_modifier)
* [character_name](#character_name)
* [country_culture](#country_culture)
* [country_leader_desc](#country_leader_desc)
* [idea_desc](#idea_desc)
* [idea_name](#idea_name)
* [tech_effect](#tech_effect)

## advisor_desc
The advisor_desc formatter gets the description for the advisor.

### Localization Scope Object
The formatter requires the following Localization Scope Objects to be defined:
* `Country` - The country that the idea is associated with.

### Example
```
custom_effect_tooltip = advisor_desc|hjalmar_schacht
```


## building_state_modifier
The building_state_modifier gets the state modifiers for the provided building template and the provided scope.

The formatter takes special care of the following parameters:
- INDENT: The indent to be added to all lines of the state modifier description (including header line).

### Example:
```
custom_effect_tooltip = building_state_modifier|dam
```


## character_name
The character_name formatter gets the name of the character.

### Example:
```
custom_effect_tooltip = character_name|hjalmar_schacht
```


## country_culture
The country_culture formatter formats the string using the country's cultural override (`TAG_token`) if it exists,
otherwise the generic version (`token`).

### Localization Scope Object
The formatter requires the following Localization Scope Objets to be defined:
* `Country` - The country that the idea is associated with.

### Example
```
custom_effect_tooltip = country_culture|generic_tank_organisation
```


## country_leader_desc
The country_leader_desc formatter gets the description for a possible country leader.

### Localization Scope Object
No scope needed - This formatter searches in the database for the character with given ideology.

### Parameters
The formatter supports two additional parameters, INDENT and IDEOLOGY
- IDEOLOGY: (Mandatory) Select the characters ideology leader role to use, use the ideology group token prefixed with 'token:'.
- INDENT: (Optional) The indent to be added to all lines of the country leader trait description (including header line).

### Example
```
custom_effect_tooltip = country_leader_desc|hjalmar_schacht

custom_effect_tooltip = {
	localization_key = country_leader_desc|hjalmar_schacht
	IDEOLOGY = token:fascism
	INDENT = 2_SPACES
```


## idea_desc
The idea_desc formatter gets the description for the idea.

### Localization Scope Object
The formatter requires the following Localization Scope Objects to be defined:
* `Country` - The country that the idea is associated with.

### Example
```
custom_effect_tooltip = idea_desc|canadian_pacific_railway
```


## idea_name
The idea_name formatter formats gets the name for the idea.

### Localization Scope Object
The formatter requires the following Localization Scope Objects to be defined:
* `Country` - The country that the idea is associated with.

### Example
```
custom_effect_tooltip = idea_name|canadian_pacific_railway
```


## tech_effect
The tech_effect formatter gets the effect of finishing a technology.

### Localization Scope Object
The formatter requires the following Localization Scope Objects to be defined:
* `Country` - The country that the tech is associated with.

### Example
```
custom_effect_tooltip = tech_effect|early_transport_plane
```