WeatherMakerCelestialObjectScript Class |
Inheritance HierarchyObject
Component
Behaviour
MonoBehaviour
DigitalRuby.WeatherMakerWeatherMakerCelestialObjectScript
Namespace: DigitalRuby.WeatherMaker
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
SyntaxThe WeatherMakerCelestialObjectScript type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | WeatherMakerCelestialObjectScript | Initializes a new instance of the WeatherMakerCelestialObjectScript class |
Properties| Name | Description | |
|---|---|---|
 | animation | Obsolete. The Animation attached to this GameObject. (Null if there is none attached). |
| audio | Obsolete. The AudioSource attached to this GameObject. (Null if there is none attached). |
| camera | Obsolete. The Camera attached to this GameObject. (Null if there is none attached). |
| collider | Obsolete. The Collider attached to this GameObject. (Null if there is none attached). |
| Collider |
The collider for this celestial object
|
| collider2D | Obsolete. The Collider2D component attached to the object. |
| constantForce | Obsolete. The ConstantForce attached to this GameObject. (Null if there is none attached). |
| Difference |
Difference (0-1) of light from last frame. A value of 1 indicates enough difference that shaders should completely re-render.
|
| enabled | Enabled Behaviours are Updated, disabled Behaviours are not. |
| Flare |
Lens flare (if any) for this celestial object
|
| gameObject | The game object this component is attached to. A component is always attached to a game object. |
| guiElement | Obsolete. (Inherited from Component.) |
| guiText | Obsolete. The GUIText attached to this GameObject. (Null if there is none attached). |
| guiTexture | Obsolete. The GUITexture attached to this GameObject (Read Only). (null if there is none attached). |
| hideFlags | Should the object be hidden, saved with the scene or modifiable by the user? |
| hingeJoint | Obsolete. The HingeJoint attached to this GameObject. (Null if there is none attached). |
| IsActive |
Whether the object is active
|
| isActiveAndEnabled | Has the Behaviour had enabled called. |
| light | Obsolete. The Light attached to this GameObject. (Null if there is none attached). |
| Light |
The light for this celestial object
|
| LightIsActive |
Whether the light for this object is active. A light that is not active is not on.
|
| LightIsOn |
Whether the light is on. An active light can have a light that is off.
|
| MeshFilter |
The mesh filter for this celestial object
|
| name | The name of the object. |
| networkView | Obsolete. The NetworkView attached to this GameObject (Read Only). (null if there is none attached). |
| OrbitTypeIsCustom |
Whether the orbit type is custom
|
| OrbitTypeIsPerspective |
Whether the orbit type is perspective (true) or orthographic (false)
|
| particleEmitter | Obsolete. The ParticleEmitter attached to this GameObject. (Null if there is none attached). |
| particleSystem | Obsolete. The ParticleSystem attached to this GameObject. (Null if there is none attached). |
| renderer | Obsolete. The Renderer attached to this GameObject. (Null if there is none attached). |
| Renderer |
The renderer for this celestial object
|
| rigidbody | Obsolete. The Rigidbody attached to this GameObject. (Null if there is none attached). |
| rigidbody2D | Obsolete. The Rigidbody2D that is attached to the Component's GameObject. |
| runInEditMode | Allow a specific instance of a MonoBehaviour to run in edit mode (only available in the editor). |
| tag | The tag of this game object. |
| transform | The Transform attached to this GameObject. |
| useGUILayout | Disabling this lets you skip the GUI layout phase. |
| ViewportPosition |
Gets the viewport positions of the object.
|
Methods| Name | Description | |
|---|---|---|
| BroadcastMessage(String) | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| BroadcastMessage(String, Object) | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| BroadcastMessage(String, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| BroadcastMessage(String, Object, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| CancelInvoke | Cancels all Invoke calls on this MonoBehaviour. |
| CancelInvoke(String) | Cancels all Invoke calls with name methodName on this behaviour. |
| CompareTag | Is this game object tagged with tag ? |
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GetComponent(Type) | Returns the component of Type type if the game object has one attached, null if it doesn't. |
| GetComponent(String) | Returns the component with name type if the game object has one attached, null if it doesn't. |
| GetComponent``1 | (Inherited from Component.) |
| GetComponentInChildren(Type) | Returns the component of Type type in the GameObject or any of its children using depth first search. |
| GetComponentInChildren(Type, Boolean) | (Inherited from Component.) |
| GetComponentInChildren``1 | (Inherited from Component.) |
| GetComponentInChildren``1(Boolean) | (Inherited from Component.) |
| GetComponentInParent(Type) | Returns the component of Type type in the GameObject or any of its parents. |
| GetComponentInParent``1 | (Inherited from Component.) |
| GetComponents(Type) | Returns all components of Type type in the GameObject. |
| GetComponents(Type, ListComponent) | (Inherited from Component.) |
| GetComponents``1 | (Inherited from Component.) |
| GetComponents``1(ListUMP) | (Inherited from Component.) |
| GetComponentsInChildren(Type) | Returns all components of Type type in the GameObject or any of its children. |
| GetComponentsInChildren(Type, Boolean) | Returns all components of Type type in the GameObject or any of its children. |
| GetComponentsInChildren``1 | (Inherited from Component.) |
| GetComponentsInChildren``1(Boolean) | (Inherited from Component.) |
| GetComponentsInChildren``1(ListUMP) | (Inherited from Component.) |
| GetComponentsInChildren``1(Boolean, ListUMP) | (Inherited from Component.) |
| GetComponentsInParent(Type) | (Inherited from Component.) |
| GetComponentsInParent(Type, Boolean) | Returns all components of Type type in the GameObject or any of its parents. |
| GetComponentsInParent``1 | (Inherited from Component.) |
| GetComponentsInParent``1(Boolean) | (Inherited from Component.) |
| GetComponentsInParent``1(Boolean, ListUMP) | (Inherited from Component.) |
| GetGradientColor |
Get a color for a gradient given directional light position
|
| GetGradientLookup |
Get a gradient lookup value given directional light position
|
| GetHashCode | (Inherited from Object.) |
| GetInstanceID | Returns the instance id of the object. |
| GetSunMieDot |
Get mie dot
|
| GetType | (Inherited from Object.) |
| Invoke | Invokes the method methodName in time seconds. |
| InvokeRepeating | Invokes the method methodName in time seconds, then repeatedly every repeatRate seconds. |
| IsInvoking | Is any invoke pending on this MonoBehaviour? |
| IsInvoking(String) | Is any invoke on methodName pending? |
| MemberwiseClone | (Inherited from Object.) |
| SendMessage(String) | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessage(String, Object) | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessage(String, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessage(String, Object, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessageUpwards(String) | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| SendMessageUpwards(String, Object) | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| SendMessageUpwards(String, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| SendMessageUpwards(String, Object, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| StartCoroutine(IEnumerator) | Starts a coroutine. |
| StartCoroutine(String) | Starts a coroutine named methodName. |
| StartCoroutine(String, Object) | Starts a coroutine named methodName. |
| StartCoroutine_Auto | Obsolete. (Inherited from MonoBehaviour.) |
| StopAllCoroutines | Stops all coroutines running on this behaviour. |
| StopCoroutine(String) | Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. |
| StopCoroutine(IEnumerator) | Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. |
| StopCoroutine(Coroutine) | Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. |
| ToString | Returns the name of the GameObject. |
| UpdateObject |
Call from the day night cycle manager update
|
Fields| Name | Description | |
|---|---|---|
 | FlareCloudProbeTarget | Game object to use as lens flare cloud probe target. This object should have a cloud probe script on it. |
| HorizonMultiplier | Horizon multiplier (x = multiplier, y = max intensity, z = power reducer). Increases light intensity in certain effects like clouds as object reaches horizon. Great for brighter sunsets. |
| IsSun | Whether this is a sun (false if moon) |
| LensFlareBlocker | Used to block lens flare if clouds are over the sun. Just needs to be a sphere collider. |
| LightBaseIntensity | The intensity of the light of the object at default (full) intensity |
| LightBaseShadowStrength | The shadow strength of the light of the object at default (full) shadow intensity |
| LightColor | Light color |
| LightMode | Light mode. If set to None, you must set the light intensity yourself. |
| LightMultiplier | Light multiplier |
| LightPower | Light power, controls how intense the light lights up the clouds, etc. near the object. Lower values reduce the radius and increase the intensity. |
| MinimumCloudCoverToBlockLensFlare | Minimum cloud cover to block the lens flare. |
| OrbitType | The orbit type. Only from Earth orbit is currently supported. |
| RotateYDegrees | Rotation about y axis - changes how the celestial body orbits over the scene |
| Scale | The scale of the object. For the sun, this is shader specific. For moons, this is a percentage of camera far plane. |
| ShaftMultiplier | Shafts multiplier. Brightens up cloud or fog shafts. Useful for moons. |
| TintColor | Tint color of the object. |
| TintIntensity | Tint intensity |
Extension Methods| Name | Description | |
|---|---|---|
 | CachedName |
Get cached name
(Defined by WeatherMakerObjectExtensions.) |
| SetCachedName |
Put name in the cache
(Defined by WeatherMakerObjectExtensions.) |
See Also