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.
====== PROCEDURAL_VECTOR3 ======

Deprecated names:
  * RANDOM_VECTOR3_RANGE

**Category**: Data

//[[:annotations#cloneable|Cloneable]]//

===== Properties =====

----

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

  * **Type**: ''[[preview:api:procedural_value_type|PROCEDURAL_VALUE_TYPE]]''
  * **Expected**: ''enum value''
  * **Default value**: ''PROCEDURAL_VALUE_TYPE.RANDOM_RANGE''

----

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

Constant value.

  * **Type**: ''[[preview:api:vec3f|vec3f]]''
  * **Expected**: ''vec3f value''

----

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

Lower value of random range.

  * **Type**: ''[[preview:api:vec3f|vec3f]]''
  * **Expected**: ''vec3f value''
  * **Default value**: ''{ 0, 0, 0 }''

----

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

Upper value of random range.

  * **Type**: ''[[preview:api:vec3f|vec3f]]''
  * **Expected**: ''vec3f value''
  * **Default value**: ''{ 1, 1, 1 }''

----

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

If true, the values will stay proportional to each other; ex. Min = { 0, 0, 1 } & Max = { 0.5, 0.5, 1 } will return random values like : { 0.25, 0.25, 0.5 }. If false, each value will be random; ex. Min = { 0, 0, 0.5 } & Max = { 0.5, 0.5, 1 } will return random values like : { 0.15, 0.45, 0.95 } or { 0.35, 0.05, 0.55 }.

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

----

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

Curve of random distribution.

  * **Type**: ''[[preview:api:easing|EASING]]''
  * **Expected**: ''enum value''
  * **Default value**: ''EASING.LINEAR''