Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.UIComp_Event

Extends
UIComponent
Modifiers
native ( inherit )

Provides a list of events that a widget can process. The outer for a UIComp_Event MUST be a UIScreenObject. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Core.Component
   |   
   +-- Engine.UIComponent
      |   
      +-- Engine.UIComp_Event

Variables Summary
array<UIRoot.DefaultEventSpecification>DefaultEvents
array<name>DisabledEventAliases
UISequenceEventContainer
UIEvent_ProcessInputInputProcessor
Inherited Variables from Core.Component
TemplateName, TemplateOwnerClass

Functions Summary
function RegisterInputEvents (UIState InputEventOwner, int PlayerIndex)
function UnregisterInputEvents (UIState InputEventOwner, int PlayerIndex)


Variables Detail

DefaultEvents Source code

var array<UIRoot.DefaultEventSpecification> DefaultEvents;
Events which should be implemented for this widget by default. For example, a button should respond to mouse clicks without requiring the designer to attach a UIEvent_ProcessClick event to every button. To accomplish this, in the UIButton class's defaultproperties you would define a UIEvent_ButtonClick object using a subobject definition, then add that event to the DefaultEvents array for the EventProvider of the UIButton class. Since this property will almost always have values assigned in defaults (via the subobject definition for this object) it isn't marked instanced (see the @note in the next comment). Instead, these objects will be manually instanced when a new widget is created.

DisabledEventAliases Source code

var array<name> DisabledEventAliases;
List of disabled UI event aliases that will not have their input subscribed.

EventContainer Source code

var instanced UISequence EventContainer;
The sequence that contains the events implemented for this widget. @note: do not give this variable a default value, or each time a UIComp_Event object is loaded from disk, StaticConstructObject (well, really InitProperties) will construct an object of this type that will be immediately overwritten when the UIComp_Event object is serialized from disk.

InputProcessor Source code

var transient UIEvent_ProcessInput InputProcessor;
The UIEvent responsible for routing input key events to kismet actions. Created at runtime whenever input keys are registered with the owning wiget.


Functions Detail

RegisterInputEvents Source code

native final function RegisterInputEvents ( UIState InputEventOwner, int PlayerIndex )
Adds the input events for the specified state to the owning scene's InputEventSubscribers
@param InputEventOwner the state that contains the input keys that should be registered with the scene
@param PlayerIndex the index of the player to register the input keys for

UnregisterInputEvents Source code

native final function UnregisterInputEvents ( UIState InputEventOwner, int PlayerIndex )
Removes the input events for the specified state from the owning scene's InputEventSubscribers
@param InputEventOwner the state that contains the input keys that should be removed from the scene
@param PlayerIndex the index of the player to unregister input keys for


Defaultproperties

defaultproperties
{
   Name="Default__UIComp_Event"
   ObjectArchetype=UIComponent'Engine.Default__UIComponent'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:46.448 - Created with UnCodeX