WeatherMakerScript Class |
Inheritance HierarchyNamespace: DigitalRuby.WeatherMaker
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
SyntaxThe WeatherMakerScript type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | WeatherMakerScript | Initializes a new instance of the WeatherMakerScript 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). |
| AuroraManager |
Aurora manager
|
| camera | Obsolete. The Camera attached to this GameObject. (Null if there is none attached). |
| CloudManager |
Cloud manager
|
| collider | Obsolete. The Collider attached to this GameObject. (Null if there is none attached). |
| collider2D | Obsolete. The Collider2D component attached to the object. |
| CommandBufferManager |
Command buffer manager
|
| constantForce | Obsolete. The ConstantForce attached to this GameObject. (Null if there is none attached). |
| enabled | Enabled Behaviours are Updated, disabled Behaviours are not. |
| FogManager |
Fog manager
|
| 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). |
| HasHadWeatherTransition |
Whether we have had a weather transition, if not first transition is instant
|
| 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). |
 | Instance |
Shared instance of weather maker manager script
|
| isActiveAndEnabled | Has the Behaviour had enabled called. |
| IsHeadlessMode |
Determine if running in headless (server only, no rendering) mode
|
| LastLocalProfile |
Last local profile that was set for the local player - do not try to set this value, it will have no effect, use a weather zone instead.
|
| light | Obsolete. The Light attached to this GameObject. (Null if there is none attached). |
| MainCamera |
Main camera
|
| name | The name of the object. |
| NetworkConnection |
Network connection info
|
| networkView | Obsolete. The NetworkView attached to this GameObject (Read Only). (null if there is none attached). |
| 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). |
| PerformanceProfile |
Get the performance profile or default profile if null
|
| PlayerSoundManager |
Player sound manager
|
| PrecipitationManager |
Precipitation manager
|
| PreviousLastLocalProfile |
Previous last local profile that was set for the local player - do not try to set this value, it will have no effect, use a weather zone instead.
|
| renderer | Obsolete. The Renderer attached to this GameObject. (Null if there is none attached). |
| 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). |
| SkyManager |
Sky manager
|
| tag | The tag of this game object. |
| ThunderAndLightningManager |
Thunder and lightning manager
|
| transform | The Transform attached to this GameObject. |
| useGUILayout | Disabling this lets you skip the GUI layout phase. |
| WindManager |
Wind manager
|
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 ? |
| EnsureInstanceT |
Ensures that an object is the correct singleton for itself
|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| FindOrCreateInstanceT |
Find or create a singleton object. In OnDestroy, you must call ReleaseInstance to avoid memory leaks.
|
| GetCameraType |
Get the type of a camera
|
| 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.) |
| GetHashCode | (Inherited from Object.) |
| GetInstanceID | Returns the instance id of the object. |
| 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? |
| IsLocalPlayer |
Get whether an object is the local player
|
| IsPlayer |
Determine if an object is a player (including network players)
|
| LoadResourceT |
Retrieve a Weather Maker resources. The resource should be added to the References property ideally, or as a fallback can be in a Resources folder.
|
| MemberwiseClone | (Inherited from Object.) |
| QueueOnMainThread |
Queue an action to run on the main thread - this action should run as fast as possible to avoid locking the main thread.
|
| RaiseWeatherProfileChanged |
Call whenever the weather profile needs to change, handles client/server, etc.
If no networking or network server, this will perform the transition.
WeatherProfileChanged will then be called.
|
| ReleaseInstanceT |
Release an instance created with FindOrCreateInstance
|
| ResolveCameraMode |
Resolve camera mode if mode is Auto. Will resolve against camera or Camera.main if camera is null
|
| 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. |
| ShouldIgnoreCamera |
Determine if a camera should be rendered in weather maker
|
| 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. |
Events| Name | Description | |
|---|---|---|
 | WeatherProfileChangedEvent |
Event that fires when the weather profile changes (old, new, transition duration, connection ids (null for all connections))
|
Fields| Name | Description | |
|---|---|---|
 | AllowCameras | Cameras that render make should render with. Only cameras in this list are rendered. Defaults to main camera. The first object in the list is the primary camera, and is used to determine orthographic vs perspective setup, etc. |
| AllowCamerasNames | A set of names for allowed cameras, useful for plugins that clone or add custom cameras that you want to allow. Names must match exactly. |
| AllowCamerasNamesPartial | A set of names for allowed cameras, useful for plugins that clone or add custom cameras that you want to allow. Names can partially match. |
| AllowSceneCamera | Allow the scene camera to render Weather Maker. This can result in UI corruption due to Unity bugs, so turn off if you see UI corruption. |
| AutoFindMainCamera | Whether to auto-find all cameras tagged as MainCamera and add them to the AllowCameras list. Set to false if you don't need this or see any performance issue. |
| CameraType | Camera mode. This affects lighting, visual effects and more. Ensure this is set to the correct value for your game or app. |
| DawnBegin | Executes when the day/night cycle becomes dawn. Parameter is WeatherMakerDayNightCycleProfileScript. |
| DayBegin | Executes when the day/night cycle becomes day. Parameter is WeatherMakerDayNightCycleProfileScript. |
| DayChanged | Executes when the day/night cycle day changes. Parameter is DateTWeatherMakerDayNightCycleProfileScriptime. |
| DuskBegin | Executes when the day/night cycle becomes dusk. Parameter is WeatherMakerDayNightCycleProfileScript. |
| HourChanged | Executes when the day/night cycle hour changes. Parameter is WeatherMakerDayNightCycleProfileScript. |
| IntensityModifierDictionary |
Allows adding additional weather intensity modifiers by key. Note that setting any values in here will override the external intensity
on any built in weather maker particle system scripts.
|
| IsPermanent | Whether the prefab should exist forever. Set to false to have the prefab destroyed with the scene it is in. |
| MinuteChanged | Executes when the day/night cycle minute changes. Parameter is WeatherMakerDayNightCycleProfileScript. |
| MonthChanged | Executes when the day/night cycle month changes. Parameter is WeatherMakerDayNightCycleProfileScript. |
| NightBegin | Executes when the day/night cycle becomes night. Parameter is WeatherMakerDayNightCycleProfileScript. |
| ResourceContainer | Put all Weather Maker references in here including scriptable object profiles, sound files, textures, etc. Only these will be bundled and included in the final build. |
| SecondChanged | Executes when the day/night cycle second changes. Parameter is WeatherMakerDayNightCycleProfileScript. |
| SunriseBegin | Executes when the day/night cycle sunrise begins. Parameter is WeatherMakerDayNightCycleProfileScript. |
| SunriseEnd | Executes when the day/night cycle sunrise ends. Parameter is WeatherMakerDayNightCycleProfileScript. |
| SunsetBegin | Executes when the day/night cycle sunset begins. Parameter is WeatherMakerDayNightCycleProfileScript. |
| SunsetEnd | Executes when the day/night cycle sunset ends. Parameter is WeatherMakerDayNightCycleProfileScript. |
| WeatherProfileChanged | Executes when the weather profile changes for the local player. Parameter is WeatherMakerProfileScript. |
| WeatherZoneChanged | Executes when the weather zones changes for the local player. Parameter is WeatherMakerWeatherZoneScript. |
| YearChanged | Executes when the day/night cycle year changes. Parameter is WeatherMakerDayNightCycleProfileScript. |
Extension Methods| Name | Description | |
|---|---|---|
 | CachedName |
Get cached name
(Defined by WeatherMakerObjectExtensions.) |
| SetCachedName |
Put name in the cache
(Defined by WeatherMakerObjectExtensions.) |
See Also