> For the complete documentation index, see [llms.txt](https://yigu-studio.gitbook.io/bannerlord-modding-cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://yigu-studio.gitbook.io/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md).

# Hero : MBObjectBase, ITrackableCampaignObject, ITrackableBase

Heroes are all the unique characters in the game. This class contains all the information of these characters and allows you to change them.

| Using / Namespaces                                                                                                              | Taleworlds.Core | Saveable |
| ------------------------------------------------------------------------------------------------------------------------------- | --------------- | -------: |
| `System`                                                                                                                        |                 |    20204 |
| `System.Collections.Generic`                                                                                                    |                 |          |
| `System.Linq`                                                                                                                   |                 |          |
| `System.Xml.Serialization`                                                                                                      |                 |          |
| `Heplers`                                                                                                                       |                 |          |
| [TaleWorlds.CampaignSystem.Actions](/bannerlord-modding-cn/_csharp-api/campaignsystem/actions/changeownerofsettlementaction.md) |                 |          |
| [TaleWorlds.CampaignSystem.CharacterDevelopment.Managers](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)            |                 |          |
| [TaleWorlds.Core](/bannerlord-modding-cn/_csharp-api/core.md)                                                                   |                 |          |
| [TaleWorlds.Library](/bannerlord-modding-cn/_csharp-api/library.md)                                                             |                 |          |
| [TaleWorlds.Localization](/bannerlord-modding-cn/_csharp-api/localization.md)                                                   |                 |          |
| [TaleWorlds.SaveSystem](/bannerlord-modding-cn/_csharp-api/savesystem.md)                                                       |                 |          |
|                                                                                                                                 |                 |          |

## Example of usage

TODO

## Variables

| Mods              | Name                           | Type                                                                                                                                                                         | Notes                                      | Value |
| ----------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | ----- |
| public const      | RelationLimit                  | `int`                                                                                                                                                                        | Max value for relation                     | 100   |
| public const      | RelationNeutralLimit           | `int`                                                                                                                                                                        | Max value for relation with neutral heroes | 10    |
| public            | LastTimeStampForActivity       | `int`                                                                                                                                                                        | Last activity timestamp                    |       |
| const             | MaximumNumberOfVolunteers      | `int`                                                                                                                                                                        | TODO                                       | 6     |
| public            | VolunteerTypes;                | [CharacterObject](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)`[]`                                                                                             | TODO                                       |       |
| public            | NumberOfCreatedParties         | `int`                                                                                                                                                                        | Number of parties                          |       |
| private readonly  | \_occupiedByAnEvent            | `List<string>`                                                                                                                                                               | TODO                                       |       |
| private           | \_passedTimeAtHomeSettlement;  | `float`                                                                                                                                                                      | Time at home settlement                    |       |
| private           | \_characterObject              | [CharacterObject](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                 | Character object info                      |       |
| public            | FirstName                      | [TextObject](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                      | First name                                 |       |
| public            | Name                           | [TextObject](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                      | Name                                       |       |
| public            | Detected                       | `bool`                                                                                                                                                                       | Have you met with hero                     |       |
| public            | DaysLeftToRespawn              | `int`                                                                                                                                                                        | Days for respawn                           |       |
| private           | \_heroStates                   | [CharacterStates](https://yigu-studio.gitbook.io/bannerlord-modding-cn/_csharp-api/campaignsystem/pages/-M5Z9ccOBgDh2lpmi3_N##-%60enum%60-CharacterStates)                   | Hero's state                               |       |
| private           | \_heroTraits                   | [CharacterTraits](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                 | Hero's traits                              |       |
| private           | \_heroPerks                    | [CharacterPerks](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                  | Hero's perks                               |       |
| private           | \_heroSkills                   | [CharacterSkills](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                 | Hero's skills                              |       |
| private           | \_charAttributeValues          | `int[6]`                                                                                                                                                                     | Character attributes points                |       |
| public            | NeverBecomePrisoner            | `bool`                                                                                                                                                                       | Will never be prisoner?                    |       |
| private           | \_alwaysUnconscious;           | `bool`                                                                                                                                                                       | TODO                                       |       |
| public            | AlwaysDie                      | `bool`                                                                                                                                                                       | Is hero always dir (for what?)             |       |
| public            | LastVisitTimeOfHomeSettlement  | `float`                                                                                                                                                                      | Last visit home settlement                 |       |
| public            | Level                          | `int`                                                                                                                                                                        | Level of hero                              |       |
| const             | HeroWoundedHealthLevel         | `int`                                                                                                                                                                        | Value, below which hero is wounded         | 20    |
| private           | \_companionOf                  | [Clan](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                            | Clan that include hero?                    |       |
| private           | \_cachedLastSeenInformation    | [HeroLastSeenInformation](https://yigu-studio.gitbook.io/bannerlord-modding-cn/_csharp-api/campaignsystem/pages/-M5Z9ccOBgDh2lpmi3_N##-%60struct%60-HeroLastSeenInformation) | Heros's last seen info                     |       |
| IsMercenary       | IsMercenary                    | `bool`                                                                                                                                                                       | Is hero mercenary                          |       |
| SpcDaysInLocation | SpcDaysInLocation              | `int`                                                                                                                                                                        | TODO                                       |       |
| private           | \_health                       | `int`                                                                                                                                                                        | Health                                     |       |
| private           | \_birthDay                     | [CampaignTime](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                    | BearthDay                                  |       |
| private           | \_deathDay                     | [CampaignTime](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                    | Day of death                               |       |
| private           | \_power                        | `int`                                                                                                                                                                        | Power                                      |       |
| public            | VisitedSettlements             | `Dictionary<`[Settlement](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)`, float>`                                                                               | Visited settlements                        |       |
| private           | \_clan                         | [Clan](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                            | Hero's clan                                |       |
| private           | \_supporterOf                  | [Clan](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                            | TODO                                       |       |
| private           | \_governorOf                   | [Town](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                            | Governor of                                |       |
| private           | \_ownedWorkshops               | `List<`[Workshop](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)`>`                                                                                              | Owned workshops                            |       |
| private           | \_ownedCommonAreas             | `List<`[CommonArea](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)`>`                                                                                            | Owned areas                                |       |
| private           | \_ownedParties                 | `List<`[PartyBase](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)`>`                                                                                             | Owned parties                              |       |
| public            | Culture                        | [CultureObject](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                   | Culture                                    |       |
| public            | \_partyBelongedTo              | [MobileParty](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                     | TODO                                       |       |
| private           | \_stayingInSettlementOfNotable | [Settlement](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                      | TODO                                       |       |
| public            | SpecialItems                   | `List<`(ItemObject)\[]`>`                                                                                                                                                    | TODO                                       |       |
| private           | \_controversy                  | `float`                                                                                                                                                                      | TODO                                       |       |
| private           | \_hasMet                       | `bool`                                                                                                                                                                       | Has hero met                               |       |
| private           | \_bornSettlement               | [Settlement](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                      | Born settlement                            |       |
| private           | \_gold                         | `int`                                                                                                                                                                        | Gold                                       |       |
| public            | RandomValue                    | `int`                                                                                                                                                                        | ??                                         |       |
| public            | RandomValueDeterministic       | `int`                                                                                                                                                                        | ??                                         |       |
| public            | RandomValueRarelyChanging      | `int`                                                                                                                                                                        | ??                                         |       |
| private           | \_father                       | [Hero](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                            | Father                                     |       |
| private           | \_mother                       | [Hero](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                            | Mother                                     |       |
| private readonly  | \_exSpouses                    | `List<`[Hero](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)`>`                                                                                                  | ??                                         |       |
| public            | ExSpouses                      | [MBReadOnlyList](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)`<`[Hero](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)`>`                           | Ex. spouses                                |       |
| private           | \_spouse                       | [Hero](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                            | Spouse                                     |       |
| private readonly  | \_children                     | `List`[Hero](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)`>`                                                                                                   | Children                                   |       |
| public            | IsFertile                      | bool                                                                                                                                                                         | Can hero have children                     |       |
| public            | IsPregnant                     | bool                                                                                                                                                                         | Is hero pregnant now                       |       |
| private reeadonly | \_heroDeveloper                | [HeroDeveloper](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)                                                                                                   | TODO                                       |       |
|                   |                                |                                                                                                                                                                              |                                            |       |

## Properties

* `internal StaticBodyProperties StaticBodyProperties` { get; set; }
* `CanHaveRecruits` - A boolean that details if this hero can have recruits. Preachers, Rural Notables, Mercenaries, Gang Leaders, Merchants, and Headmen can have recruits. This property can only be read, not changed.

## Functions

Work in progress

## `struct` HeroLastSeenInformation

| Name               | Type                                                                      | Notes |
| ------------------ | ------------------------------------------------------------------------- | ----- |
| LastSeenPlace      | [Settlement](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md)   | TODO  |
| LastSeenDate       | [CampaignTime](/bannerlord-modding-cn/_csharp-api/campaignsystem/hero.md) | TODO  |
| IsNearbySettlement | bool                                                                      | TODO  |
|                    |                                                                           |       |

## `enum` CharacterStates

* NotSpawned
* Active
* Fugitive
* Prisoner
* Released
* Dead
* Disabled

## `enum` FactionRank

* None = -1
* Vassal
* Leader
