Show / Hide Table of Contents

Class TweenOptionsContainer

Base class for Tween and TweenGroup that contains the options and reference counting.

Inheritance
System.Object
TweenOptionsContainer
Tween
TweenGroup
TweenTemplate
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ToString()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Sttz.Tweener
Assembly: cs.temp.dll.dll
Syntax
public abstract class TweenOptionsContainer

Fields

_retainCount

Declaration
protected uint _retainCount
Field Value
Type Description
System.UInt32

Options

Options of the tween or group.

Declaration
public readonly TweenOptions Options
Field Value
Type Description
TweenOptions

Properties

RetainCount

Retain count that prevents recycling of a tween or group when it's greater than zero.

Declaration
public uint RetainCount { get; set; }
Property Value
Type Description
System.UInt32
Remarks

By default, tweens and groups are recycled after they've completed. If you want to hang on to a tween or group, there are two options:

  • Disable recycling completely for a tween or group using Recycle.
  • Increase the retain count as long as you're using a tween or group and then decrease it again to allow the tween or group to be recycled.

Methods

ReturnToPool()

Called when RetainCount reaches zero.

Declaration
protected abstract void ReturnToPool()
Back to top © 2018 Adrian Stutz