This page will show the public values and methods available to scripters to control the MegaScatter system.<\/p>\n
This holds the two types that control how many scattered objects appear in the scene.
\n[cc lang=”c#”]public enum MegaScatterMode
\n{
\n\tDensity,
\n\tCount,
\n}[\/cc]<\/p>\n
Scatter count is calculated from Area of meshes and splines.<\/p>\n
Scatter count is set via the Count values in MegaScatter and MegaScatterMeshInf classes.<\/p>\n
This simple class is used for Texture scatter objects to define color masks.
\n[cc lang=”c#”]public class MegaScatterCol
\n{
\n\tpublic Color lowcol;
\n\tpublic Color highcol;
\n}[\/cc]<\/p>\n
Defines the start of a color range used by Texture scatter classes, texture color will need to fall between this and highcol for an object to be placed.<\/p>\n
Defines the end of a color range used by Texture scatter classes, texture color will need to fall between this and lowcol for an object to be placed.<\/p>\n
This is the main Scatter Layer Name for the layer.<\/p>\n Whether the layer is active in the scatter or not.<\/p>\n The source object to use for this layer.<\/p>\n How much this layer will contribute to the overall scatter count. The higher the number relative to other layers the more of this layer object will be in the scatter.<\/p>\n A quick scale value for this layer, makes it easier if you have source objects of different sizes.<\/p>\n Should the random scaling be uniform across all axis or use per axis values. If true then uniscalelow and uniscalehigh will be used as the scaling range, if false scaleLow and scaleHigh will be used.<\/p>\n The low value for the uniform scaling variation.<\/p>\n The high value for the uniform scaling variation.<\/p>\n Some objects have differnt up values etc, so here you can correct that so objects appear correctly when scattered.<\/p>\n The low scale Vector3 value to use for scaling variation.<\/p>\n The high scale Vector3 value to use for scaling variation.<\/p>\n The low rotation Vector3 value to use for rotation variation.<\/p>\n The high scale Vector3 value to use for rotation variation.<\/p>\n The low offset Vector3 value to use for positioning variation.<\/p>\n The high offset Vector3 value to use for positioning variation.<\/p>\n The position snap values, use this to make objects snap to grid positions.<\/p>\n The rotation snap values, use this to make scatter objects only use certain angles.<\/p>\n This curve describes the distribution of the random number.<\/p>\n The random number seed for the layer.<\/p>\n Set tto true if you want the system to check for overlapping objects.<\/p>\n The radius for the layer used in the overlap test.<\/p>\n When scattering against walls etc you can increase the radius check size to force things away from ignore objects, Has no effect on overlap just on ignore objects.<\/p>\n Number of rays to use in the raycasts, the more used the more accurate the tests.<\/p>\n Value from 0 to 1 to say how much the layer should align with any ground object.<\/p>\n Clears the overlap data so layer can overlap already scattered objects but not itself.<\/p>\n Marks any created objects as static in the scene.<\/p>\n For scatter along objects this is the min distance from the spline an object can appear, 0 means on the spline.<\/p>\n For scatter along objects this is the max distance from the spline an object can appear.<\/p>\n How much the vertical coloring alpha is applied to the layer.<\/p>\n Curve that controls the vertical coloring of the mesh alpha, can be used to make things stiffer at the bottom etc.<\/p>\n This value will override any counts calculated for this layer. 0 means use calculated count.<\/p>\n The maximum number of objects to be scattered for this layer, again will override any other count values.<\/p>\n If the scatter shape is made up of multiple splines setting this will mean the counts are calculated for each spline as opposed to the whole shape.<\/p>\n For scattering to textures this holds the list of the various color masks for the scattering.<\/p>\n For scatter along objects you can control the scaling of the scatter mesh based on distance from the spline using this curve.<\/p>\n The max vertex count before a new mesh is created.<\/p>\n Set to true to apply vertex noise to mesh scatters.<\/p>\n The roughness of the noise.<\/p>\n How much noise to apply to each axis.<\/p>\n If the scatter objects are being colored this list holds the color variations to use.<\/p>\n The min slope angle this layer can be scattered on.<\/p>\n The max slope angle this layer can be scattered on.<\/p>\n Allows for control of how far above or below the ground meshes will appear, useful for fine tuning meshes to sit nicely on the ground if their pivots are not at the base.<\/p>\n Set to true to use the height values below to control scattering.<\/p>\n The height below which this layer will not be scattered.<\/p>\n The height above which this layer will not be scattered.<\/p>\n This class is used to describe objects that scatters can and can not appear on. The collider object to use in the scene.<\/p>\n Whether is collider is used in the scatter tests.<\/p>\n This is the base class for the various Scatter Object types in the system. Set to true to have scatter objects at start.<\/p>\n set to true to allow the system to rescatter.<\/p>\n Tells the system to make a new mesh for each spline in the scatter shape or color mask for texture scatters.<\/p>\n The density value, the higher the more objects will be scattered.<\/p>\n The number of meshes to scatter when in Count mode.<\/p>\n The mode to use to calculate how many meshes are to be scattered, Count or Density.<\/p>\n If the shape to scatter to has multiple splines you can limit the splines to use by changing this.<\/p>\n If the shape to scatter to has multiple splines you can limit the splines to use by changing this.<\/p>\n Whether this scatter objects does raycast to position objects on the ground.<\/p>\n If raycasting but no ground set then with this set to true no object will appear unless there is ground for it.<\/p>\n How far above the shape raycasts start.<\/p>\n The shape to scatter into or along.<\/p>\n This is a list of bools one per spline in the shape so you can turn off or on a spline to control the scatter.<\/p>\n The layers to scatter for this object (see above)<\/p>\n The random number see for this object.<\/p>\n Will hide any objects generated i the hierarchy.<\/p>\n A scaling value to apply to all layers, makes it easy to adjust the whole scatter object if it is not the right size.<\/p>\n With multiple spline shapes will tell the system to detect holes and to scatter or not into them.<\/p>\n Tells the system to color the meshes.<\/p>\n List of colliders the scatter should not scatter on or near.<\/p>\n List of colliders that the scatter should scatter on.<\/p>\n Not currently used.<\/p>\n Texture scatters can use either a texture or a textured object.<\/p>\n [cc lang=”c#”]public void SetShape(MegaShape newshape)[\/cc]<\/p>\n The shape used for the scattering can be changed by calling this method with the new MegaShape object to use. Returns a string for the layer whose index is passed in.<\/p>\n [cc lang=”c#”]public bool IsLayerOn(string name)[\/cc]<\/p>\n Returns true if the layer with the name passed is active in the scatter, false if it is not.<\/p>\n [cc lang=”c#”]public bool IsLayerOn(int i)[\/cc]<\/p>\n Returns true is the layer is On false if it is Off.<\/p>\n [cc lang=”c#”]public void LayerActive(string name, bool onoff)[\/cc]<\/p>\n Allows you to turn on or off scatter layers by name.<\/p>\n [cc lang=”c#”]public void LayerActive(int i, bool onoff)[\/cc]<\/p>\n Allows you to turn on or off scatter layers by index.<\/p>\n [cc lang=”c#”]public int FindLayerIndex(string name)[\/cc]<\/p>\n Returns the index for the passed layer name. Returns -1 if name not found.<\/p>\n [cc lang=”c#”]public void ReScatter()[\/cc] [cc lang=”c#”]public int GetLayerScatterCount(string name)[\/cc]<\/p>\n Returns the count value for all the objects that were scattered for the layer. Can be used with GetLayerScatterPos to get the positions for all the objects that were placed in the scene.<\/p>\n [cc lang=”c#”]public int GetLayerScatterCount(int i)[\/cc]<\/p>\n Returns the count value for all the objects that were scattered for the layer. Can be used with GetLayerScatterPos to get the positions for all the objects that were placed in the scene.<\/p>\n [cc lang=”c#”]public MegaScatterMeshInf GetLayer(string name)[\/cc]<\/p>\n Returns the MegaScatterMeshInf class for the named layer so the values can be altered.<\/p>\n [cc lang=”c#”]public MegaScatterMeshInf GetLayer(int i)[\/cc]<\/p>\n Returns the MegaScatterMeshInf class for the indexe layer so the values can be altered.<\/p>\n [cc lang=”c#”]public Vector3 GetLayerScatterPos(string name, int num)[\/cc]<\/p>\n Returns the Vector3 value for the given object on the given layer, useful if you need to know where objects were placed.<\/p>\n [cc lang=”c#”]public Vector3 GetLayerScatterPos(int i, int num)[\/cc]<\/p>\n Returns the Vector3 value for the given object on the given layer, useful if you need to know where objects were placed.<\/p>\n Coming soon.<\/p>\n","protected":false},"excerpt":{"rendered":" This page will show the public values and methods available to scripters to control the MegaScatter system. MegaScatter Enums This holds the two types that control how many scattered objects […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":4853,"menu_order":0,"comment_status":"open","ping_status":"open","template":"","meta":[],"_links":{"self":[{"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=\/wp\/v2\/pages\/4911"}],"collection":[{"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=4911"}],"version-history":[{"count":18,"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=\/wp\/v2\/pages\/4911\/revisions"}],"predecessor-version":[{"id":4936,"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=\/wp\/v2\/pages\/4911\/revisions\/4936"}],"up":[{"embeddable":true,"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=\/wp\/v2\/pages\/4853"}],"wp:attachment":[{"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=4911"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
\n[cc lang=”c#”]public class MegaScatterLayer
\n{
\n\tpublic string\t\t\t\tLayerName;
\n\tpublic bool\t\t\t\t\tEnabled;
\n\tpublic GameObject\t\t\tobj;
\n\tpublic float\t\t\t\tweight;
\n\tpublic float\t\t\t\tscale;
\n\tpublic bool\t\t\t\t\tuniformScaling;
\n\tpublic float\t\t\t\tuniscaleLow;
\n\tpublic float\t\t\t\tuniscaleHigh;
\n\tpublic Vector3\t\t\t\tprerot;
\n\tpublic Vector3\t\t\t\tscaleLow;
\n\tpublic Vector3\t\t\t\tscaleHigh;
\n\tpublic Vector3\t\t\t\trotLow;
\n\tpublic Vector3\t\t\t\trotHigh;
\n\tpublic Vector3\t\t\t\toffsetLow;
\n\tpublic Vector3\t\t\t\toffsetHigh;
\n\tpublic Vector3\t\t\t\tsnap;
\n\tpublic Vector3\t\t\t\tsnapRot;
\n\tpublic AnimationCurve\t\tdistCrv;
\n\tpublic int\t\t\t\t\tseed;
\n\tpublic bool\t\t\t\t\tnoOverlap;
\n\tpublic float\t\t\t\tradius;
\n\tpublic float\t\t\t\tcolradiusadj;
\n\tpublic int\t\t\t\t\traycount;
\n\tpublic float\t\t\t\talign;
\n\tpublic bool\t\t\t\t\tclearOverlap;
\n\tpublic bool\t\t\t\t\tmarkstatic;
\n\tpublic float\t\t\t\tminDistance;
\n\tpublic float\t\t\t\tmaxDistance;
\n\tpublic float\t\t\t\tcolAmt;
\n\tpublic AnimationCurve\t\tcolcurve;
\n\tpublic int\t\t\t\t\tforcecount;
\n\tpublic int\t\t\t\t\tmaxcount;
\n\tpublic bool\t\t\t\t\tperCurveCount;
\n\tpublic List
\n\tpublic AnimationCurve\t\tscaleOnDist;
\n\tpublic int\t\t\t\t\tvertexlimit;
\n\tpublic bool\t\t\t\t\tvertexnoise;
\n\tpublic float\t\t\t\tnoisescale;
\n\tpublic Vector3\t\t\t\tstrength;
\n\tpublic List
\n\tpublic float\t\t\t\tminslope;
\n\tpublic float\t\t\t\tmaxslope;
\n\tpublic float\t\t\t\tcollisionOffset;
\n\tpublic bool\t\t\t\t\tuseheight;
\n\tpublic float\t\t\t\tminheight;
\n\tpublic float\t\t\t\tmaxheight;
\n}[\/cc]<\/p>\nMembers<\/h3>\n
LayerName<\/strong><\/h4>\n
Enabled<\/strong><\/h4>\n
obj<\/strong><\/h4>\n
weight<\/strong><\/h4>\n
scale<\/strong><\/h4>\n
uniformScaling<\/strong><\/h4>\n
uniscaleLow<\/strong><\/h4>\n
uniscaleHigh<\/strong><\/h4>\n
prerot<\/strong><\/h4>\n
scaleLow<\/strong><\/h4>\n
scaleHigh<\/strong><\/h4>\n
rotLow<\/strong><\/h4>\n
rotHigh<\/strong><\/h4>\n
offsetLow<\/strong><\/h4>\n
offsetHigh<\/strong><\/h4>\n
snap<\/strong><\/h4>\n
snapRot<\/strong><\/h4>\n
distCrv<\/strong><\/h4>\n
seed<\/strong><\/h4>\n
noOverlap<\/strong><\/h4>\n
radius<\/strong><\/h4>\n
colradiusadj<\/strong><\/h4>\n
raycount<\/strong><\/h4>\n
align<\/strong><\/h4>\n
clearOverlap<\/strong><\/h4>\n
markstatic<\/strong><\/h4>\n
minDistance<\/strong><\/h4>\n
maxDistance<\/strong><\/h4>\n
colAmt<\/strong><\/h4>\n
colcurve<\/strong><\/h4>\n
forcecount<\/strong><\/h4>\n
maxcount<\/strong><\/h4>\n
perCurveCount<\/strong><\/h4>\n
scattercols<\/strong><\/h4>\n
scaleOnDist<\/strong><\/h4>\n
vertexlimit<\/strong><\/h4>\n
vertexnoise<\/strong><\/h4>\n
noisescale<\/strong><\/h4>\n
strength<\/strong><\/h4>\n
colvariations<\/strong><\/h4>\n
minslope<\/strong><\/h4>\n
maxslope<\/strong><\/h4>\n
collisionOffset<\/strong><\/h4>\n
useheight<\/strong><\/h4>\n
minheight<\/strong><\/h4>\n
maxheight<\/strong><\/h4>\n
MegaScatterCollisionObj<\/h3>\n
\n[cc lang=”c#”]public class MegaScatterCollisionObj
\n{
\n\tpublic Collider\tcollider;
\n\tpublic bool\t\tactive;
\n}[\/cc]<\/p>\nMembers<\/h3>\n
collider<\/strong><\/h4>\n
active<\/strong><\/h4>\n
MegaScatter<\/h3>\n
\n[cc lang=”c#”]public class MegaScatter : MonoBehaviour
\n{
\n\tpublic bool\t\t\t\t\t\t\tbuildOnStart;
\n\tpublic bool\t\t\t\t\t\t\tupdate;
\n\tpublic bool\t\t\t\t\t\t\tmeshPerShape;
\n\tpublic float\t\t\t\t\t\tDensity;
\n\tpublic int\t\t\t\t\t\t\tforcecount;
\n\tpublic MegaScatterMode\t\t\t\tcountmode;
\n\tpublic int\t\t\t\t\t\t\tStartCurve
\n\tpublic int\t\t\t\t\t\t\tEndCurve;
\n\tpublic bool\t\t\t\t\t\t\traycast;
\n\tpublic bool\t\t\t\t\t\t\tNeedsGround;
\n\tpublic float\t\t\t\t\t\tcollisionOffset;
\n\tpublic MegaShape\t\t\t\t\tshape;
\n\tpublic List
\n\tpublic List
\n\tpublic int\t\t\t\t\t\t\tseed = 0;
\n\tpublic bool\t\t\t\t\t\t\thideObjects;
\n\tpublic Vector3\t\t\t\t\t\tglobalScale;
\n\tpublic bool\t\t\t\t\t\t\tfillHoles;
\n\tpublic bool\t\t\t\t\t\t\tcolorMesh;
\n\tpublic List
\n\tpublic List
\n\tpublic MegaScatterQuery\t\t\t\tqueryObject;
\n\tpublic Collider\t\t\t\t\t\ttexturecollider;
\n}[\/cc]<\/p>\nMembers<\/h3>\n
buildOnStart<\/strong><\/h4>\n
update<\/strong><\/h4>\n
meshPerShape<\/strong><\/h4>\n
Density<\/strong><\/h4>\n
forcecount<\/strong><\/h4>\n
countmode<\/strong><\/h4>\n
StartCurve<\/strong><\/h4>\n
EndCurve<\/strong><\/h4>\n
raycast<\/strong><\/h4>\n
NeedsGround<\/strong><\/h4>\n
CollisionOffset<\/strong><\/h4>\n
shape<\/strong><\/h4>\n
usespline<\/strong><\/h4>\n
layers<\/strong><\/h4>\n
seed<\/strong><\/h4>\n
hideObjects<\/strong><\/h4>\n
globalScale<\/strong><\/h4>\n
fillHoles<\/strong><\/h4>\n
colorMesh<\/strong><\/h4>\n
ignoreobjs<\/strong><\/h4>\n
surfaces<\/strong><\/h4>\n
queryObject<\/strong><\/h4>\n
texturecollider<\/strong><\/h4>\n
MegaScatter Methods<\/h3>\n
\n[cc lang=”c#”]public int NumLayers()[\/cc]
\nReturns an int with the number of mesh layers the scatter object uses.
\n[cc lang=”c#”]public string GetLayerName(int i)[\/cc]<\/p>\n
\nonoff<\/strong> – bool value for the new state of the layer.\n<\/div>\n
\nonoff<\/strong> – bool value for the new state of the layer.\n<\/div>\n
\nTells the Scatter object to re scatter.<\/p>\n
\nnum<\/strong> – The index of the scattered object to get the position for. Use GetLayerScatterCount to get the max index value.\n<\/div>\n
\nnum<\/strong> – The index of the scattered object to get the position for. Use GetLayerScatterCount to get the max index value.\n<\/div>\nExample Code<\/h3>\n