• Manual
  • Scripting API
Show / Hide Table of Contents
  • ScriptableFramework
    • AnimatorList
    • AnimatorListPopulator
    • AnimatorReference
    • AnimatorReferencePopulator
    • AppEvent
    • AppEvent<T>
    • AppEventBase
    • AppEventListener
    • AppEventListener<T>
    • AppEventListenerBase
    • AppVersion
    • BoolEvent
    • BoolEventListener
    • BoolList
    • BoolResponse
    • BoolValue
    • BoundsEvent
    • BoundsEventListener
    • BoundsResponse
    • ColorEvent
    • ColorEventListener
    • ColorList
    • ColorResponse
    • ColorValue
    • DataString
    • DefaultState
    • Dragable
    • Extensions
    • FloatEvent
    • FloatEventListener
    • FloatList
    • FloatResponse
    • FloatValue
    • FoldoutAttribute
    • GameObjectList
    • GameObjectListPopulator
    • GameObjectReference
    • GameObjectReferencePopulator
    • InputValidation
    • IntEvent
    • IntEventListener
    • IntList
    • IntResponse
    • IntValue
    • IReferenceContainer
    • IValueContainer
    • MeshRendererList
    • MeshRendererListPopulator
    • MeshRendererReference
    • MeshRendererReferencePopulator
    • PathType
    • Platform
    • ReferenceItem<T>
    • ReferenceList<T>
    • ReleaseType
    • RuntimeItem<T>
    • RuntimeList<T>
    • RuntimeObject
    • RuntimeObjectManager
    • SceneAsset
    • SceneAsset.SceneLoadException
    • SearchableEnumAttribute
    • StateChange
    • StateMachine
    • StateMachineBase
    • StateMachineController
    • StateMachineReset
    • StateToggle
    • StringEvent
    • StringEventListener
    • StringList
    • StringResponse
    • StringValue
    • TransformList
    • TransformListPopulator
    • TransformReference
    • TransformReferencePopulator
    • ValueItem<T>
    • ValueList<T>
    • Vector2Event
    • Vector2EventListener
    • Vector2List
    • Vector2Response
    • Vector2Value
    • Vector3Event
    • Vector3EventListener
    • Vector3List
    • Vector3Response
    • Vector3Value
  • ScriptableFramework.CustomEditors
    • AppEventEditor
    • AppEventListenerEditor
    • AppVersionEditor
    • DataStringEditor
    • EditorOverride
    • EditorOverride.Cache
    • EditorOverride.Colors
    • FrameworkExtensions
    • RuntimeObjectEditor
    • RuntimeObjectManagerEditor
    • SceneAssetEditor
    • SearchableEnumDrawer
    • SearchablePopup
  • ScriptableFramework.Tests
    • AppEventGenericTests
    • AppEventGenericTests.ClearData
    • AppEventGenericTests.RaiseEvent
    • AppEventGenericTests.RegisterListener
    • AppEventGenericTests.UnregisterListener
    • AppEventListenerGenericTests
    • AppEventListenerGenericTests.OnEventRaised
    • AppEventListenerGenericTests.RegisterSelf
    • AppEventListenerGenericTests.UnregisterSelf
    • AppEventListenerTests
    • AppEventListenerTests.OnEventRaised
    • AppEventListenerTests.RegisterSelf
    • AppEventListenerTests.UnregisterSelf
    • AppEventTests
    • AppEventTests.ClearData
    • AppEventTests.RaiseEvent
    • AppEventTests.RegisterListener
    • AppEventTests.UnregisterListener
    • DataStringTests
    • ListenerResponder
    • ReferenceItemTests
    • ReferenceItemTests.ClearData
    • ReferenceItemTests.ClearWithForAssetReferencingOnly
    • ReferenceListTests
    • ReferenceListTests.ClearData
    • ReferenceListTests.ClearWithForAssetReferencingOnly
    • StateMachineTests
    • StateMachineTests.ClearData
    • StateMachineTests.ReapplyState
    • StateMachineTests.UpdateStateForAll
    • StateMachineTests.UpdateStateForIndex
    • StateMachineTests.UpdateStateForRange
    • StateMachineTests.UpdateStateForSingle
    • StateToggleTests
    • StateToggleTests.RespondToStateMachineChange
    • StateToggleTests.UpdateStateMachine
    • StringListTests
    • ValueItemTests
    • ValueItemTests.ClearData
    • ValueListTests
    • ValueListTests.ClearData

Class AppEventListener<T>

A generic component which listens to an AppEvent of the same type. Inherit from this class to create your own AppEventListener sub class. In the inspector, drag and drop in the list of responses to set up which funtions will be called when the event is raised.

Inheritance
System.Object
AppEventListenerBase
AppEventListener<T>
BoolEventListener
BoundsEventListener
ColorEventListener
FloatEventListener
IntEventListener
StringEventListener
Vector2EventListener
Vector3EventListener
Namespace: ScriptableFramework
Assembly: cs.temp.dll.dll
Syntax
public abstract class AppEventListener<T> : AppEventListenerBase
Type Parameters
Name Description
T

The type for this listener to receive from the event when it is raised.

Fields

Event

The generic event that is being listened to.

Declaration
protected AppEvent<T> Event
Field Value
Type Description
AppEvent<T>

Response

The generic UnityEvent that can have delegates assigned to in the inspector. These delegates will be invoked when the event is raised and have an object of type T passed to them from the event.

Declaration
protected UnityEvent<T> Response
Field Value
Type Description
UnityEvent<T>

valueForManualTrigger

A default input value for OnEventRaised ().

Declaration
public T valueForManualTrigger
Field Value
Type Description
T

Methods

OnEventRaised()

Invokes all delegates asigned to this response in the inspector using a default input.

Declaration
public override bool OnEventRaised()
Returns
Type Description
System.Boolean

Returns whether the event response was successful or not.

Overrides
AppEventListenerBase.OnEventRaised()

OnEventRaised(T)

Invokes all delegates asigned to this response in the inspector using an input provided by the event.

Declaration
public bool OnEventRaised(T value)
Parameters
Type Name Description
T value
Returns
Type Description
System.Boolean

Returns whether the event response was successful or not.

RegisterSelf()

If Event is not null, register this object to it.

Declaration
public override bool RegisterSelf()
Returns
Type Description
System.Boolean

Returns whether the registration was successful or not.

Overrides
AppEventListenerBase.RegisterSelf()

SetInternalEventAndResponse()

Declaration
public abstract void SetInternalEventAndResponse()

UnregisterSelf()

If Event is not null, unregister this object from it.

Declaration
public override bool UnregisterSelf()
Returns
Type Description
System.Boolean

Returns whether the unregistration was successful or not.

Overrides
AppEventListenerBase.UnregisterSelf()
Back to top Generated by DocFX