 | ShieldTSource, TArgs Class |
Inheritance HierarchyObject
Component
Behaviour
MonoBehaviour
Archon.SwissArmyLib.ResourceSystemResourcePoolBase
Archon.SwissArmyLib.ResourceSystemResourcePoolTSource, TArgs
Archon.SwissArmyLib.ResourceSystemShieldTSource, TArgs
Archon.SwissArmyLib.ResourceSystemShield
Namespace: Archon.SwissArmyLib.ResourceSystem
Assembly: Archon.SwissArmyLib (in Archon.SwissArmyLib.dll) Version: 1.0.0.0 (1.0.0.0)
Syntaxpublic class Shield<TSource, TArgs> : ResourcePool<TSource, TArgs>, IEventListener<IResourcePreChangeEvent<TSource, TArgs>>, IEventListener<IResourceEvent<TSource, TArgs>>
Type Parameters
- TSource
[Missing <typeparam name="TSource"/> documentation for "T:Archon.SwissArmyLib.ResourceSystem.Shield`2"]
- TArgs
[Missing <typeparam name="TArgs"/> documentation for "T:Archon.SwissArmyLib.ResourceSystem.Shield`2"]
The ShieldTSource, TArgs type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ShieldTSource, TArgs | Initializes a new instance of the ShieldTSource, TArgs class |
Properties| Name | Description | |
|---|---|---|
 | AbsorptionFlat |
Gets or sets the flat amount of removed resource that should be absorbed by the shield.
|
| AbsorptionScaling |
Gets or sets the fraction of removed resource that should be absorbed by the shield.
|
| 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). |
| collider2D | Obsolete. The Collider2D component attached to the object. |
| constantForce | Obsolete. The ConstantForce attached to this GameObject. (Null if there is none attached). |
| Current |
Gets the current amount of resource in this pool.
(Inherited from ResourcePoolTSource, TArgs.) |
| DefaultArgs |
Gets the args to fallback on if no args is specified.
(Inherited from ResourcePoolTSource, TArgs.) |
| DefaultSource |
Gets the source to fallback on if no source is specified.
(Inherited from ResourcePoolTSource, TArgs.) |
| EmptiesWithTarget |
Gets or sets whether the shield should get fully drained when the target is empty.
|
| EmptyTillRenewed |
Gets or sets whether adding resource should be disabled after the pool is completely empty, until it is renewed using Renew(TSource, TArgs, Boolean) again.
(Inherited from ResourcePoolTSource, TArgs.) |
| enabled | Enabled Behaviours are Updated, disabled Behaviours are not. |
| 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). |
| isActiveAndEnabled | Has the Behaviour had enabled called. |
| IsEmpty |
Gets whether the pool is completely empty.
(Inherited from ResourcePoolTSource, TArgs.) |
| IsFull |
Gets whether the pool is completely empty.
(Inherited from ResourcePoolTSource, TArgs.) |
| light | Obsolete. The Light attached to this GameObject. (Null if there is none attached). |
| Max |
Gets or sets the maximum amount of source that can be in this pool.
(Inherited from ResourcePoolTSource, TArgs.) |
| name | The name of the object. |
| 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). |
| Percentage |
Gets a how full the resource is percentage-wise (0 to 1)
(Inherited from ResourcePoolTSource, TArgs.) |
| ProtectedTarget |
Gets or sets the target that this shield should protect.
|
| renderer | Obsolete. The Renderer attached to this GameObject. (Null if there is none attached). |
| RenewsWithTarget |
Gets or sets whether the shield should renew when the target does.
|
| 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. |
| TimeSinceEmpty |
Get the (scaled) time since this pool was last empty.
(Inherited from ResourcePoolTSource, TArgs.) |
| transform | The Transform attached to this GameObject. |
| useGUILayout | Disabling this lets you skip the GUI layout phase. |
Methods| Name | Description | |
|---|---|---|
| Add(Single, Boolean) |
Adds the specified amount of resource to the pool.
(Inherited from ResourcePoolTSource, TArgs.) |
| Add(Single, TSource, Boolean) |
Adds the specified amount of resource to the pool.
(Inherited from ResourcePoolTSource, TArgs.) |
| Add(Single, TSource, TArgs, Boolean) |
Adds the specified amount of resource to the pool.
(Inherited from ResourcePoolTSource, TArgs.) |
 | Awake |
Called when the MonoBehaviour is added to a GameObject.
(Overrides ResourcePoolTSource, TArgsAwake.) |
| 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. |
| Change |
Changes the resource amount by delta.
(Overrides ResourcePoolTSource, TArgsChange(Single, TSource, TArgs, Boolean).) |
| CompareTag | Is this game object tagged with tag ? |
| Empty(Boolean) |
Completely empties the pool.
(Inherited from ResourcePoolTSource, TArgs.) |
| Empty(TSource, Boolean) |
Completely empties the pool.
(Inherited from ResourcePoolTSource, TArgs.) |
| Empty(TSource, TArgs, Boolean) |
Completely empties the pool.
(Inherited from ResourcePoolTSource, TArgs.) |
| Equals | (Inherited from Object.) |
| Fill(Boolean) |
Fully fills the pool.
(Inherited from ResourcePoolTSource, TArgs.) |
| Fill(Single, Boolean) |
Fills the pool to the specified amount.
(Inherited from ResourcePoolTSource, TArgs.) |
| Fill(TSource, Boolean) |
Fully fills the pool.
(Inherited from ResourcePoolTSource, TArgs.) |
| Fill(Single, TSource, Boolean) |
Fills the pool to the specified amount.
(Inherited from ResourcePoolTSource, TArgs.) |
| Fill(TSource, TArgs, Boolean) |
Fully fills the pool.
(Inherited from ResourcePoolTSource, TArgs.) |
| Fill(Single, TSource, TArgs, Boolean) |
Fills the pool to the specified amount.
(Inherited from ResourcePoolTSource, TArgs.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (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.) |
| GetHashCode | (Inherited from Object.) |
| GetInstanceID | Returns the instance id of the object. |
| GetType | Gets the type of the current instance. (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 | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnDisable |
Called when the MonoBehaviour is disabled.
|
| OnEnable |
Called when the MonoBehaviour is enabled.
|
| OnEvent(Int32, IResourceEventTSource, TArgs) |
Called when an event is invoked.
|
| OnEvent(Int32, IResourcePreChangeEventTSource, TArgs) |
Called when an event is invoked.
|
| Remove(Single, Boolean) |
Removes the specified amount of resource to the pool.
(Inherited from ResourcePoolTSource, TArgs.) |
| Remove(Single, TSource, Boolean) |
Removes the specified amount of resource to the pool.
(Inherited from ResourcePoolTSource, TArgs.) |
| Remove(Single, TSource, TArgs, Boolean) |
Removes the specified amount of resource to the pool.
(Inherited from ResourcePoolTSource, TArgs.) |
| Renew(Boolean) |
Fully restores the pool, regardless of EmptyTillRenewed.
(Inherited from ResourcePoolTSource, TArgs.) |
| Renew(Single, Boolean) |
Restores the pool to the specified amount, regardless of EmptyTillRenewed.
(Inherited from ResourcePoolTSource, TArgs.) |
| Renew(TSource, Boolean) |
Fully restores the pool, regardless of EmptyTillRenewed.
(Inherited from ResourcePoolTSource, TArgs.) |
| Renew(Single, TSource, Boolean) |
Restores the pool to the specified amount, regardless of EmptyTillRenewed.
(Inherited from ResourcePoolTSource, TArgs.) |
| Renew(TSource, TArgs, Boolean) |
Fully restores the pool, regardless of EmptyTillRenewed.
(Inherited from ResourcePoolTSource, TArgs.) |
| Renew(Single, TSource, TArgs, Boolean) |
Restores the pool to the specified amount, regardless of EmptyTillRenewed.
(Inherited from ResourcePoolTSource, TArgs.) |
| 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) | (Inherited from MonoBehaviour.) |
| ToString | Returns the name of the game object. |
Fields| Name | Description | |
|---|---|---|
 | OnChange |
Event called after the resource amount has been changed.
(Inherited from ResourcePoolTSource, TArgs.) |
| OnEmpty |
Event called once the pool has been completely emptied.
(Inherited from ResourcePoolTSource, TArgs.) |
| OnFull |
Event called when the pool has been completely filled.
(Inherited from ResourcePoolTSource, TArgs.) |
| OnPreChange |
Event called just before the resource amount is changed.
You can affect the applied change by modifying ModifiedDelta.
(Inherited from ResourcePoolTSource, TArgs.) |
| OnRenew |
Event called when the pool is renewed using Renew(TSource, TArgs, Boolean).
(Inherited from ResourcePoolTSource, TArgs.) |
Extension Methods| Name | Description | |
|---|---|---|
 | StartBetterCoroutine(IEnumerator, UpdateLoop) | Overloaded.
Starts a new coroutine.
(Defined by BetterCoroutinesExtensions.) |
| StartBetterCoroutine(IEnumerator, Int32) | Overloaded.
Starts a new coroutine.
(Defined by BetterCoroutinesExtensions.) |
| StartBetterCoroutineLinked(IEnumerator, UpdateLoop) | Overloaded.
Starts a new coroutine with its lifetime linked to this component.
The coroutine will be stopped when the linked component is disabled or destroyed.
(Defined by BetterCoroutinesExtensions.) |
| StartBetterCoroutineLinked(IEnumerator, Int32) | Overloaded.
Starts a new coroutine with its lifetime linked to this component.
The coroutine will be stopped when the linked component is disabled or destroyed.
(Defined by BetterCoroutinesExtensions.) |
| StopBetterCoroutine |
Stops a running coroutine prematurely.
This will stop any child coroutines as well.
(Defined by BetterCoroutinesExtensions.) |
See Also