Click or drag to resize

DustProductions.TriggerMeTimbers Namespace

Trigger anything for Unity projects. Depends on DustProductions.Core
Public classCacheableTriggerable
A Triggerable that also performs caching, allowing us to easily set values to their cached versions.
Public classTrigger
Triggers are objects that care about something in the world and notify Triggerables when the thing they care about happens. The notification is in the form of either sending the Triggerable true or false.
Public classTriggerable
Inherit from this to easily implement Triggerable behaviour. Once you do so, and implement the abstract methods, you will be able to hook your class into all the Triggers TriggerMeTimbers has to offer. If you are unable to inherit from this, you can also just implement the ITriggerable interface.
Public classTriggerableAddForceToRigidbody
Use apply physics forces to a Rigidbody on some sort of trigger. If you aren't sure what type of force to use, check Unity's documentation.
Public classTriggerableAudioSourcePlayback
Control the playback for a AudioSource based on some sort of trigger.
Public classTriggerablePlayAnimation Obsolete.
This class was used to play animations for versions prior to Unity 2017.3, but it now no longer works. It will be replaced in a future version of Trigger Me Timbers. No additional documentation will be provided.
Public classTriggerableSelectSelectable
Allows the selection of UnityEngine.UI.Selectable objects. Only one Selectable can ever be selected in the game at a time.
Public classTriggerableSetAudioSourceAudioClip
Swaps the AudioClip on AudioSources based on some sort of trigger.
Public classTriggerableSetBehavioursEnabled
Allows you to set Behaviours to a custom enabled status, or back to what they were when cached on some sort of trigger.
Public classTriggerableSetColor
Sets Color values on some sort of trigger.
Public classTriggerableSetFloat
Sets float values on some sort of trigger.
Public classTriggerableSetGameObjectsActive
Allows you to set GameObjects to a custom active status, or back to what they were when cached on some sort of trigger.
Public classTriggerableSetImageSprite
Sets the Sprite on an Image based on some sort of trigger.
Public classTriggerableSetInputText
Sets the text of an InputField on a trigger.
Public classTriggerableSetMouseCursor
Sets the mouse pointer to a predefined CursorDefinition based on some sort of trigger.
Public classTriggerableSetText
Allows you to set Text components to a custom string or back to their cached value on a trigger.
Public classTriggerableSetToggle
Use to set Toggles to a value when triggered.
Public classTriggerableSetTransformValues
Allows you to set values on a Transform based on some other behaviour. Works for Transforms and RectTransforms.
Public classTriggerFilter
This is both a Trigger and an ITriggerable, which means it can be a bridge between the two. The reason this class exists in that way is so you can consolidate multiple Triggers into a single Trigger.
Public classTriggerOnAwake
Triggers when Awake or OnDestroy are called.
Public classTriggerOnButtonClick
Allows you to Trigger things when a Button is clicked.
Public classTriggerOnColliderTrigger
Triggers when this object collides with a Collider that has "Is Trigger" set to true.
Public classTriggerOnCollision
Triggers when this object collides with another collider.
Public classTriggerOnDrag
Triggers when the pointer attempts to drag a UI object.
Public classTriggerOnEnable
Triggers when this MonoBehaviour is enabled or disabled.
Public classTriggerOnHover
Triggers when a pointer enters or exits a UI object's area.
Public classTriggerOnInputText
Triggers when certain things happen to an InputField class.
Public classTriggerOnKeyPress
Triggers when an input button or combination of buttons is pressed. This MonoBehaviour has to use the Update function. The highest performance trigger setting is "OnAnyKey", followed by "OnAnyKeyInArray", followed by "OnAllKeysInArray". This component provides a simple way to handle input in your game. For more complicated games, you might wish to extend this or write a custom solution.
Public classTriggerOnPointerClick
Triggers when the pointer clicks on a UI element.
Public classTriggerOnSceneLoad
Trigger that pays attention to scene loading.
Public classTriggerOnStart
Trigger on Unity's Start and OnDestroy calls.
Public classTriggerOnTimer
Triggers when a certain amount of time passes. Time passing is based on Time.deltaTime called in Update.
Public classTriggerOnToggled
Triggers when things happen to a Toggle.
Public classTriggerOnUpdate
Uses Unity's Update functions to send Triggers. I would recommend using as few of these as possible, as most everything should be able to be done without the Update functions using Trigger Me Timbers.
Public interfaceITriggerable
Implement this interface on anything you want to hook into a Trigger. Useful if you have some other inheritance (preventing you from inheriting from the Triggerable class), and still want to leverage everything TriggerMeTimbers has to offer.