ProceduralPlanets
ProceduralPlanets.BlueprintPlanet Class Reference

This is the parent class of planet blueprints containing some of the core variables, classes and methods. Derived from Bluprint class which contains some core classes, lists, and methods common to all types of blueprints. More...

Public Member Functions

virtual void CreateRing ()
 Creates a ring as a child to this planet blueprint. More...
 
virtual bool HasRing ()
 Answers the question if planet blueprint has a ring or not. More...
 
virtual BlueprintRing GetRing ()
 Gets the blueprint ring if one exists. More...
 
virtual string ExportToJSON (bool _easyRead=true)
 Exports this planet blueprint to a JSON string. More...
 
virtual string ImportFromJSON (string _jsonString)
 Imports a planet blueprint from a JSON string. More...
 
- Public Member Functions inherited from ProceduralPlanets.Blueprint
virtual float GetMin (string _key)
 Gets the minimum value of a PropertyFloat (this will be the lowest/min value of Random.Range when planet/ring is random setting a property. More...
 
virtual float GetMax (string _key)
 Gets the maximum value of a PropertyFloat (this will be the highest/max value of Random.Range when planet/ring is random setting a property. More...
 
virtual Color GetColor (string _key)
 Gets the base color of a Property Color (hue, saturation, and brightness ranges will be relative to this color). More...
 
virtual float GetHueRange (string _key)
 Gets the Hue range that wil determine the random min/max value of hue from the base color of a ProeprtyColor. More...
 
virtual float GetSaturationRange (string _key)
 Gets the Saturationrange that wil determine the random min/max value of saturation from the base color of a ProeprtyColor. More...
 
virtual float GetBrightnessRange (string _key)
 Gets the Brightness range that wil determine the random min/max value of brightness from the base color of a ProeprtyColor. More...
 
virtual int GetMaterialMask (string _key)
 Gets the material mask to be used when materials is randomly selected in a PropertyMaterial. More...
 
virtual int GetMaterialLength (string _key)
 Gets the length mask string array. More...
 

Public Attributes

float probability = 0.5f
 
float ringProbability = 0.5f
 
- Public Attributes inherited from ProceduralPlanets.Blueprint
List< BlueprintPropertyFloatblueprintPropertyFloats = new List<BlueprintPropertyFloat>(0)
 
List< BlueprintPropertyColorblueprintPropertyColors = new List<BlueprintPropertyColor>(0)
 
List< BlueprintPropertyMaterialblueprintPropertyMaterials = new List<BlueprintPropertyMaterial>(0)
 

Additional Inherited Members

- Protected Member Functions inherited from ProceduralPlanets.Blueprint
virtual void AddBlueprintPropertyFloat (string _key, string _label, float _min, float _max, bool _clamp01, bool _displayAsInt)
 Adds a BlueprintPropertyFloat which is used by derived classes in the Reset() method to add all the settings for a particular planet/ring type. More...
 
virtual void AddBlueprintPropertyColor (string _key, string _label, Color _color, float _hueRange, float _saturationRange, float _brightnessRange)
 Adds a BlueprintPropertyColor which is used by derived classes in the Reset() method to add all the settings for a particular planet/ring type. More...
 
virtual void AddBlueprintPropertyMaterial (string _key, string _label, ProceduralMaterial[] _materials)
 Adds a BlueprintPropertyMaterial which is used by derived classes in the Reset() method to add all the settings for a particular planet/ring type. More...
 
virtual BlueprintPropertyFloat FindBlueprintPropertyFloat (string _key)
 Finds a BlueprintPropertyFloat by key. More...
 
virtual BlueprintPropertyColor FindBlueprintPropertyColor (string _key)
 Finds a BlueprintPropertyColor by key. More...
 
virtual BlueprintPropertyMaterial FindBlueprintPropertyMaterial (string _key)
 Finds a BlueprintPropertyMaterial by key. More...
 

Detailed Description

This is the parent class of planet blueprints containing some of the core variables, classes and methods. Derived from Bluprint class which contains some core classes, lists, and methods common to all types of blueprints.

Version 1.0 - 2018 (c) Imphenzia AB - Author: Stefan Persson

Inheritance diagram for ProceduralPlanets.BlueprintPlanet:
ProceduralPlanets.Blueprint ProceduralPlanets.BlueprintGasPlanet ProceduralPlanets.BlueprintSolidPlanet

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