====== COMP_SOLDIER ======

**Category**: Component

Parent class:  [[:api:component|COMPONENT]]\\

//[[:annotations#lazy-init|Lazy-init]]//

===== Functions =====

----

==== removeWeapon ====

''void **removeWeapon**([//refundCurrentWeapon//])''

^ Name ^ Type ^ Description ^
| //''refundCurrentWeapon''// | ''[[:data-types#boolean|boolean]]'' |  |

----

==== setAssetWeapon ====

''void **setAssetWeapon**(//assetWeapon// [, //refundCurrentWeapon//])''

^ Name ^ Type ^ Description ^
| //''assetWeapon''// | ''[[:api:weapon|WEAPON]]'' |  |
| //''refundCurrentWeapon''// | ''[[:data-types#boolean|boolean]]'' |  |

----

==== getWeaponTrainingPurpose ====

''[[:api:interactive_location_purpose|INTERACTIVE_LOCATION_PURPOSE]] **getWeaponTrainingPurpose**()''


----

==== getAssetWeapon ====

''[[:api:weapon|WEAPON]] **getAssetWeapon**()''


----

==== getStrength ====

''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]] **getStrength**()''


''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]] **getStrength**(//favoredWeaponMultiplier//)''

^ Name ^ Type ^ Description ^
| //''favoredWeaponMultiplier''// | ''[[:data-types#float|float]]'' |  |

----

==== getPotentialStrength ====

''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]] **getPotentialStrength**()''


----

==== getSoldierRank ====

''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]] **getSoldierRank**()''


----

==== getSoldierState ====

''[[:api:soldier_training_state|SOLDIER_TRAINING_STATE]] **getSoldierState**()''


''[[:api:soldier_training_state|SOLDIER_TRAINING_STATE]] **getSoldierState**(//trainingValue//)''

^ Name ^ Type ^ Description ^
| //''trainingValue''// | ''[[:data-types#float|float]]'' |  |

===== Events =====

----

==== ON_TRAINING_CHANGED ====
''ON_TRAINING_CHANGED([[:data-types#float|float]] previousTrainingValue, [[:data-types#float|float]] currentTrainingValue)''

----

==== ON_STRENGTH_CHANGED ====
''ON_STRENGTH_CHANGED([[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]] previousStrength, [[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]] currentStrength)''

----

==== ON_WEAPON_CHANGED ====
''ON_WEAPON_CHANGED([[:api:weapon|WEAPON]] previousWeapon, [[:api:weapon|WEAPON]] currentWeapon)''

----

==== ON_WOUNDED_CHANGED ====
''ON_WOUNDED_CHANGED([[:data-types#boolean|boolean]] isWounded)''