====== COMP_IMMIGRATION_MANAGER ======

**Category**: Component

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

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

===== Properties =====

----

==== CheatInstantImmigration ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#boolean|boolean]]''
  * **Expected**: ''boolean value''
  * **Default value**: ''false''

----

==== ImmigrantProfile ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:api:agent_profile|AGENT_PROFILE]]''
  * **Expected**: ''asset ID''

===== Functions =====

----

==== getDaysUntilImmigration ====

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


----

==== getIsImmigrationEnabled ====

''[[:data-types#boolean|boolean]] **getIsImmigrationEnabled**()''


----

==== setIsImmigrationEnabled ====

''void **setIsImmigrationEnabled**(//isEnabled//)''

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

----

==== triggerImmigration ====

''void **triggerImmigration**([//forceImmigration// [, //forcedImmigrationCount//]])''

^ Name ^ Type ^ Description ^
| //''forceImmigration''// | ''[[:data-types#boolean|boolean]]'' |  |
| //''forcedImmigrationCount''// | ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  |