ParticleEffect Members
From Project Mercury API
| |
| Project Mercury API Reference |
| ParticleEffect Members |
| ParticleEffect Class Constructors Methods Fields Properties Events See Also Send Feedback |
[This is preliminary documentation and is subject to change.]
The ParticleEffect type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | ParticleEffect |
Initializes a new instance of the ParticleEffect class.
|
Methods
| Name | Description | |
|---|---|---|
| Add |
Adds an object to the end of the List<(Of <(T>)>).
(Inherited from List<(Of <(Emitter>)>).) |
| AddRange |
Adds the elements of the specified collection to the end of the List<(Of <(T>)>).
(Inherited from List<(Of <(Emitter>)>).) |
| AsReadOnly |
Returns a read-only IList<(Of <(T>)>) wrapper for the current collection.
(Inherited from List<(Of <(Emitter>)>).) |
| BinarySearch | Overloaded. |
| Clear |
Removes all elements from the List<(Of <(T>)>).
(Inherited from List<(Of <(Emitter>)>).) |
| Contains |
Determines whether an element is in the List<(Of <(T>)>).
(Inherited from List<(Of <(Emitter>)>).) |
| ConvertAll<(Of <(TOutput>)>) |
Converts the elements in the current List<(Of <(T>)>) to another type, and returns a list containing the converted elements.
(Inherited from List<(Of <(Emitter>)>).) |
| CopyTo | Overloaded. |
| DeepCopy |
Returns a deep copy of the ParticleEffect.
|
| Equals | (Inherited from Object.) |
| Exists |
Determines whether the List<(Of <(T>)>) contains elements that match the conditions defined by the specified predicate.
(Inherited from List<(Of <(Emitter>)>).) |
 | Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
| Find |
Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire List<(Of <(T>)>).
(Inherited from List<(Of <(Emitter>)>).) |
| FindAll |
Retrieves all the elements that match the conditions defined by the specified predicate.
(Inherited from List<(Of <(Emitter>)>).) |
| FindIndex | Overloaded. |
| FindLast |
Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire List<(Of <(T>)>).
(Inherited from List<(Of <(Emitter>)>).) |
| FindLastIndex | Overloaded. |
| ForEach |
Performs the specified action on each element of the List<(Of <(T>)>).
(Inherited from List<(Of <(Emitter>)>).) |
| GetEnumerator |
Returns an enumerator that iterates through the List<(Of <(T>)>).
(Inherited from List<(Of <(Emitter>)>).) |
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetRange |
Creates a shallow copy of a range of elements in the source List<(Of <(T>)>).
(Inherited from List<(Of <(Emitter>)>).) |
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) |
| IndexOf | Overloaded. |
| Initialise |
Initialises all Emitters within the ParticleEffect.
|
| Insert |
Inserts an element into the List<(Of <(T>)>) at the specified index.
(Inherited from List<(Of <(Emitter>)>).) |
| InsertRange |
Inserts the elements of a collection into the List<(Of <(T>)>) at the specified index.
(Inherited from List<(Of <(Emitter>)>).) |
| LastIndexOf | Overloaded. |
| LoadContent |
Loads content required by Emitters within the ParticleEffect.
|
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| OnNameChanged |
Raises the [E:NameChanged] event.
|
| Remove |
Removes the first occurrence of a specific object from the List<(Of <(T>)>).
(Inherited from List<(Of <(Emitter>)>).) |
| RemoveAll |
Removes the all the elements that match the conditions defined by the specified predicate.
(Inherited from List<(Of <(Emitter>)>).) |
| RemoveAt |
Removes the element at the specified index of the List<(Of <(T>)>).
(Inherited from List<(Of <(Emitter>)>).) |
| RemoveRange |
Removes a range of elements from the List<(Of <(T>)>).
(Inherited from List<(Of <(Emitter>)>).) |
| Reverse | Overloaded. |
| Sort | Overloaded. |
| Terminate |
Terminates all Emitters within the ParticleEffect with immediate effect.
|
| ToArray |
Copies the elements of the List<(Of <(T>)>) to a new array.
(Inherited from List<(Of <(Emitter>)>).) |
| ToString | (Inherited from Object.) |
| Trigger | Overloaded. |
| TrimExcess |
Sets the capacity to the actual number of elements in the List<(Of <(T>)>), if that number is less than a threshold value.
(Inherited from List<(Of <(Emitter>)>).) |
| TrueForAll |
Determines whether every element in the List<(Of <(T>)>) matches the conditions defined by the specified predicate.
(Inherited from List<(Of <(Emitter>)>).) |
| Update | Overloaded. |
Fields
| Name | Description | |
|---|---|---|
 | Author |
Gets or sets the author of the ParticleEffect.
|
| Description |
Gets or sets the description of the ParticleEffect.
|
Properties
| Name | Description | |
|---|---|---|
 | ActiveParticlesCount |
Gets the total number of active Particles in the ParticleEffect.
|
| Capacity |
Gets or sets the total number of elements the internal data structure can hold without resizing.
(Inherited from List<(Of <(Emitter>)>).) |
| Count |
Gets the number of elements actually contained in the List<(Of <(T>)>).
(Inherited from List<(Of <(Emitter>)>).) |
| Item | Overloaded. |
| Name |
Gets or sets the name of the ParticleEffect.
|
Events
| Name | Description | |
|---|---|---|
 | NameChanged |
Occurs when name of the ParticleEffect has been changed.
|
