Skip to content

Updated Hero documentation with some functions #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VolsungaSaga wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated Hero documentation with some functions #89

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion _csharp-api/campaignsystem/hero.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,24 @@ TODO

## Functions

Work in progress

| Mods | Signature | Return Type | Notes |
| ----------------- | ----------------------------- | -------------------------------------------------------------- | ------------------------------------------ |
| public | GetHeroSkills() | `CharacterSkills` | CharacterSkills is a descendent of 'PropertyOwner' class, should make tutorial for 'PropertyOwner'.|
| public | ChangeHeroGold(int changeAmount) | `void` | Has logic to handle reaching 64(?) bit integer's max value |
| public | AddSkillXp(SkillObject skill, float xpAmount) | `void` | Invokes \_heroDeveloper 's AddSkillXp function, which does the actual skill xp calculations. |
| public | AddPower(float value) | `void` | Not sure if anything other than the 'Notable' type of Hero will use this function. |
| public | GetHeroTraits() | `CharacterTraits` | CharacterTraits is also a descendant of 'PropertyOwner'. |
| public | GetPosition() | `vec3` |If the hero is attached to a party or a settlement, this function will return the party/settlement's position |
| public | GetRelation(Hero otherHero) | `int` | Returns an 'effective relation' value that is modified by personality differences between the Heros and overridden by the relation between the heros' clan leaders.|
| public | GetRelationWithPlayer() | `int` | Gets this Hero's relation with the Main Hero (you) |
| public | GetBaseHeroRelation(Hero otherHero) | `int` | Returns the 'base relation' value, unmodified by personality or clan leader relationships. |
| public | IsEnemy(Hero otherHero) | `bool` | Returns true if relation to other hero < -10 . Threshold is hardcoded, unfortunately.|
| public | IsFriend(Hero otherHero) | `bool` | Returns true if relation to other hero > 10 |






## `struct` HeroLastSeenInformation
Expand Down