MoreMountains.Tools.MMSpawnAroundProperties Class Reference

This class is used to describe spawn properties, to be used by the MMSpawnAround class. It's meant to be exposed and used by classes that are designed to spawn objects, typically loot systems. More...

Public Types
enum	MMSpawnAroundShapes { Sphere , Cube }
	the possible shapes objects can be spawned within More...

Public Attributes
MMSpawnAroundShapes	Shape = MMSpawnAroundShapes.Sphere
	the shape within which objects should spawn
float	MinimumSphereRadius = 1f
	the minimum distance to the origin of the spawn at which objects can be spawned
float	MaximumSphereRadius = 2f
	the maximum distance to the origin of the spawn at which objects can be spawned
Vector3	MinimumCubeBaseSize = Vector3.one
	the minimum size of the cube's base
Vector3	MaximumCubeBaseSize = new Vector3(2f, 2f, 2f)
	the maximum size of the cube's base
bool	ForcePlane = true
	if this is true, spawn will be constrained to the plane defined by the NormalToSpawnPlane property
Vector3	NormalToSpawnPlane = Vector3.up
	a Vector3 that specifies the normal to the plane you want to spawn objects on (if you want to spawn objects on the x/z plane, the normal to that plane would be the y axis (0,1,0)
float	MinimumNormalAxisOffset = 0f
	the minimum offset to apply on the normal axis
float	MaximumNormalAxisOffset = 0f
	the maximum offset to apply on the normal axis
bool	UseNormalAxisOffsetCurve = false
	whether or not to use a curve to offset the object's spawn position along the spawn plane
AnimationCurve	NormalOffsetCurve = new AnimationCurve(new Keyframe(0, 1f), new Keyframe(1, 1f))
	a curve used to define how distance to the origin should be altered (potentially above min/max distance)
float	NormalOffsetCurveRemapZero = 0f
	the value to which the curve's zero should be remapped to
float	NormalOffsetCurveRemapOne = 1f
	the value to which the curve's one should be remapped to
bool	InvertNormalOffsetCurve = false
	whether or not to invert the curve (horizontally)
Vector3	MinimumRotation = Vector3.zero
	the minimum random rotation to apply (in degrees)
Vector3	MaximumRotation = Vector3.zero
	the maximum random rotation to apply (in degrees)
Vector3	MinimumScale = Vector3.one
	the minimum random scale to apply
Vector3	MaximumScale = Vector3.one
	the maximum random scale to apply

Detailed Description

This class is used to describe spawn properties, to be used by the MMSpawnAround class. It's meant to be exposed and used by classes that are designed to spawn objects, typically loot systems.

Member Enumeration Documentation

MMSpawnAroundShapes

enum MoreMountains.Tools.MMSpawnAroundProperties.MMSpawnAroundShapes

the possible shapes objects can be spawned within

Enumerator
Sphere
Cube

Member Data Documentation

ForcePlane

bool MoreMountains.Tools.MMSpawnAroundProperties.ForcePlane = true

if this is true, spawn will be constrained to the plane defined by the NormalToSpawnPlane property

InvertNormalOffsetCurve

bool MoreMountains.Tools.MMSpawnAroundProperties.InvertNormalOffsetCurve = false

whether or not to invert the curve (horizontally)

MaximumCubeBaseSize

Vector3 MoreMountains.Tools.MMSpawnAroundProperties.MaximumCubeBaseSize = new Vector3(2f, 2f, 2f)

the maximum size of the cube's base

MaximumNormalAxisOffset

float MoreMountains.Tools.MMSpawnAroundProperties.MaximumNormalAxisOffset = 0f

the maximum offset to apply on the normal axis

MaximumRotation

Vector3 MoreMountains.Tools.MMSpawnAroundProperties.MaximumRotation = Vector3.zero

the maximum random rotation to apply (in degrees)

MaximumScale

Vector3 MoreMountains.Tools.MMSpawnAroundProperties.MaximumScale = Vector3.one

the maximum random scale to apply

MaximumSphereRadius

float MoreMountains.Tools.MMSpawnAroundProperties.MaximumSphereRadius = 2f

the maximum distance to the origin of the spawn at which objects can be spawned

MinimumCubeBaseSize

Vector3 MoreMountains.Tools.MMSpawnAroundProperties.MinimumCubeBaseSize = Vector3.one

the minimum size of the cube's base

MinimumNormalAxisOffset

float MoreMountains.Tools.MMSpawnAroundProperties.MinimumNormalAxisOffset = 0f

the minimum offset to apply on the normal axis

MinimumRotation

Vector3 MoreMountains.Tools.MMSpawnAroundProperties.MinimumRotation = Vector3.zero

the minimum random rotation to apply (in degrees)

MinimumScale

Vector3 MoreMountains.Tools.MMSpawnAroundProperties.MinimumScale = Vector3.one

the minimum random scale to apply

MinimumSphereRadius

float MoreMountains.Tools.MMSpawnAroundProperties.MinimumSphereRadius = 1f

the minimum distance to the origin of the spawn at which objects can be spawned

NormalOffsetCurve

AnimationCurve MoreMountains.Tools.MMSpawnAroundProperties.NormalOffsetCurve = new AnimationCurve(new Keyframe(0, 1f), new Keyframe(1, 1f))

a curve used to define how distance to the origin should be altered (potentially above min/max distance)

NormalOffsetCurveRemapOne

float MoreMountains.Tools.MMSpawnAroundProperties.NormalOffsetCurveRemapOne = 1f

the value to which the curve's one should be remapped to

NormalOffsetCurveRemapZero

float MoreMountains.Tools.MMSpawnAroundProperties.NormalOffsetCurveRemapZero = 0f

the value to which the curve's zero should be remapped to

NormalToSpawnPlane

Vector3 MoreMountains.Tools.MMSpawnAroundProperties.NormalToSpawnPlane = Vector3.up

a Vector3 that specifies the normal to the plane you want to spawn objects on (if you want to spawn objects on the x/z plane, the normal to that plane would be the y axis (0,1,0)

Shape

MMSpawnAroundShapes MoreMountains.Tools.MMSpawnAroundProperties.Shape = MMSpawnAroundShapes.Sphere

the shape within which objects should spawn

UseNormalAxisOffsetCurve

bool MoreMountains.Tools.MMSpawnAroundProperties.UseNormalAxisOffsetCurve = false

whether or not to use a curve to offset the object's spawn position along the spawn plane

---

The documentation for this class was generated from the following file:

• H:/Code/MoreMountains/feel/Assets/Feel/MMTools/Accessories/MMInstantiation/MMSpawnAround.cs