WindZone

Info

WindZone inherits from [Component](/docs/create/lua/API/Component/index.html)

Wind Zones add realism to the trees you create by making them wave their branches and leaves as if blown by the wind.

Members

Properties

Name	Description
WindZone.mode	Defines the type of wind zone to be used (Spherical or Directional).
WindZone.radius	Radius of the Spherical Wind Zone (only active if the WindZoneMode is set to Spherical).
WindZone.windMain	The primary wind force. It produces a softly changing wind Pressure.
WindZone.windPulseFrequency	Defines the frequency of the wind changes.
WindZone.windPulseMagnitude	Defines how much the wind changes over time.
WindZone.windTurbulence	The turbulence wind force. Produces a rapidly changing wind pressure.

Inherited Members

Inherited Properties

Name	Description
WindZone.gameObject	The game object this component is attached to. A component is always attached to a game object.
WindZone.tag	The tag of this game object.
WindZone.transform	The Transform attached to this GameObject.
WindZone.hideFlags	Should the object be hidden, saved with the Scene or modifiable by the user?
WindZone.name	The name of the object.

Inherited Methods

Name	Description
WindZone.BroadcastMessage(methodName, parameter=nil)	Calls the method named methodName on every Lua Script in this game object or any of its children.
WindZone.CompareTag(tag)	Is this game object tagged with tag ?
WindZone.GetAllLuaScripts()	Returns an array of all Lua scripts that attached to the game object.
WindZone.GetComponent(type)	Returns the component of Type type if the game object has one attached, nil if it doesn't.
WindZone.GetComponentInChildren(t)	Returns the component of Type type in the GameObject or any of its children using depth first search.
WindZone.GetComponentInParent(t)	Returns the component of Type type in the GameObject or any of its parents.
WindZone.GetComponents(type)	Returns all components of Type type in the GameObject.
WindZone.GetComponentsInChildren(t)	Returns all components of Type type in the GameObject or any of its children.
WindZone.GetComponentsInParent(t)	Returns all components of Type type in the GameObject or any of its parents.
WindZone.SendMessage(methodName, value=nil)	Calls the method named methodName on every Lua Script in this game object.
WindZone.SendMessageUpwards(methodName, value=nil)	Calls the method named methodName on every LuaScript in this game object and on every ancestor of the behaviour.
WindZone.TryGetComponent(type)	Gets the component of the specified type, if it exists.
WindZone.GetInstanceID()	Returns the instance id of the object.