Foundation - Modding Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== UPS_OBJECT_SETUP ======

**Category**: Asset\\
**Mod Dependency**: [[https://foundation.mod.io/foundation-ebf|Foundation EBF]]

Parent class:  [[api:asset|ASSET]]\\

===== Properties =====

----

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

  * **Type**: ''string''
  * **Expected**: ''string value''

----

==== ObjectPrefab ====
//[[:annotations#serialized|Serialized]]//
  * **Type**: ''[[api:prefab|PREFAB]]''
  * **Default value**: ''nil''

----

==== ObjectArea ====
//[[:annotations#serialized|Serialized]]//
  * **Type**: ''[[api:vec2f|vec2f]]''
  * **Default value**: ''{ 1, 1 }''

----

==== EdgeCheckResoluton ====
//[[:annotations#serialized|Serialized]]//
  * **Type**: ''[[api:vec2i|vec2i]]''
  * **Default value**: ''{ 0, 0 }''

----

==== AreaCheckMode ====
//[[:annotations#serialized|Serialized]]//
  * **Type**: ''string''
  * **Default value**: ''Hourglass''
  * **Other Accepted Modes:** ''Cross''**,** ''Combined''

----

==== AreaCheckResolution ====
//[[:annotations#serialized|Serialized]]//
  * **Type**: ''[[api:vec2i|vec2i]]''
  * **Default value**: ''{ 0, 0 }''

----

==== OnTerrain ====
//[[:annotations#serialized|Serialized]]//
  * **Type**: ''boolean''
  * **Default value**: ''true''

----

==== OnWater ====
//[[:annotations#serialized|Serialized]]//
  * **Type**: ''boolean''
  * **Default value**: ''false''

----

==== MinAllowedSlope ====
//[[:annotations#serialized|Serialized]]//
  * **Type**: ''float''
  * **Default value**: ''80.0''
  * **90 being fully flat land and 0 a sharp cliff**

----

==== AllowedAngles ====
//[[:annotations#serialized|Serialized]]//
  * **Type**: ''[[api:vec2f|vec2f]]''
  * **Default value**: ''{ -180, 180 }''

----

==== SelfExclusionRadius ====
//[[:annotations#serialized|Serialized]]//
  * **Type**: ''float''
  * **Default value**: ''50.0''

----

==== BuildingPartExclusionRadius ====
//[[:annotations#serialized|Serialized]]//
  * **Type**: ''float''
  * **Default value**: ''10.0''
  * **Set to 0 to disable!**
  * **This is a computationally heavy check! If you are certain your pefabs won't overlap with other building parts or if overlaps are not a problem I highly recommend disabling it! **

----