Events (Nu)

Events Module

Namespace: Nu
Assembly: Nu.dll

Engine and simulation events that come with Nu.

Functions and values

Function or value	Description
`Events.AssetsReloadEvent` Full Usage: `Events.AssetsReloadEvent` Returns: `unit Address`	Raised when game assets are reloaded. Returns: `unit Address`
`Events.BodyAddingEvent` Full Usage: `Events.BodyAddingEvent` Returns: `BodyId Address`	Raised when a body is added to a physics system. Returns: `BodyId Address`
`Events.BodyJointBreakEvent` Full Usage: `Events.BodyJointBreakEvent` Returns: `BodyJointBreakData Address`	Raised when a physics joint is broken. Returns: `BodyJointBreakData Address`
`Events.BodyPenetrationEvent` Full Usage: `Events.BodyPenetrationEvent` Returns: `BodyPenetrationData Address`	Raised when a physics body is penetrated. Returns: `BodyPenetrationData Address`
`Events.BodyRemovingEvent` Full Usage: `Events.BodyRemovingEvent` Returns: `BodyId Address`	Raised when a body is removed from a physics system. Returns: `BodyId Address`
`Events.BodySeparationExplicitEvent` Full Usage: `Events.BodySeparationExplicitEvent` Returns: `BodySeparationExplicitData Address`	Raised when a physics body is separated explicitly by a physics engine itegration. Returns: `BodySeparationExplicitData Address`
`Events.BodySeparationImplicitEvent` Full Usage: `Events.BodySeparationImplicitEvent` Returns: `BodySeparationImplicitData Address`	Raised when a physics body is separated implicitly, such as by its containing entity being destroyed. Returns: `BodySeparationImplicitData Address`
`Events.BodyTransformEvent` Full Usage: `Events.BodyTransformEvent` Returns: `BodyTransformData Address`	Raised when a physics body is transformed in space. Returns: `BodyTransformData Address`
`Events.ChangeEvent propertyName` Full Usage: `Events.ChangeEvent propertyName` Parameters: propertyName : `string` Returns: `ChangeData Address`	Raised when a simulant's property is changed. propertyName : `string` Returns: `ChangeData Address`
`Events.ClickEvent` Full Usage: `Events.ClickEvent` Returns: `unit Address`	Raised when a button is clicked. Returns: `unit Address`
`Events.CodeReloadEvent` Full Usage: `Events.CodeReloadEvent` Returns: `unit Address`	Raised when game code is reloaded. Returns: `unit Address`
`Events.DeselectingEvent` Full Usage: `Events.DeselectingEvent` Returns: `unit Address`	Raised when a screen is deselected. Returns: `unit Address`
`Events.DialEvent` Full Usage: `Events.DialEvent` Returns: `bool Address`	Raised when a radio button is dialed. Returns: `bool Address`
`Events.DialedEvent` Full Usage: `Events.DialedEvent` Returns: `unit Address`	Raised when a dial is pressed. Returns: `unit Address`
`Events.DownEvent` Full Usage: `Events.DownEvent` Returns: `unit Address`	Raised when a button is pressed. Returns: `unit Address`
`Events.ExitRequestEvent` Full Usage: `Events.ExitRequestEvent` Returns: `unit Address`	Raised when the OS issues an exit request to the application. Returns: `unit Address`
`Events.FocusEvent` Full Usage: `Events.FocusEvent` Returns: `unit Address`	Raised when a text gui gains focus. Returns: `unit Address`
`Events.GamepadButtonChangeEvent index` Full Usage: `Events.GamepadButtonChangeEvent index` Parameters: index : `int` Returns: `GamepadButtonData Address`	Raised when a gamepad button is pressed or released. index : `int` Returns: `GamepadButtonData Address`
`Events.GamepadButtonDownEvent index` Full Usage: `Events.GamepadButtonDownEvent index` Parameters: index : `int` Returns: `GamepadButtonData Address`	Raised when a gamepad direction is pressed. index : `int` Returns: `GamepadButtonData Address`
`Events.GamepadButtonUpEvent index` Full Usage: `Events.GamepadButtonUpEvent index` Parameters: index : `int` Returns: `GamepadButtonData Address`	Raised when a gamepad direction is released. index : `int` Returns: `GamepadButtonData Address`
`Events.GamepadDirectionChangeEvent index` Full Usage: `Events.GamepadDirectionChangeEvent index` Parameters: index : `int` Returns: `GamepadDirectionData Address`	Raised when a gamepad direction is changed. index : `int` Returns: `GamepadDirectionData Address`
`Events.IncomingFinishEvent` Full Usage: `Events.IncomingFinishEvent` Returns: `unit Address`	Raised when a screen has just finished transitioning in. Returns: `unit Address`
`Events.IncomingStartEvent` Full Usage: `Events.IncomingStartEvent` Returns: `unit Address`	Raised when a screen has just started transitioning in. Returns: `unit Address`
`Events.IntegrationEvent` Full Usage: `Events.IntegrationEvent` Returns: `IntegrationData Address`	Raised when physics integration occurs, which is when a physics engine processes its messages. Returns: `IntegrationData Address`
`Events.KeyboardKeyChangeEvent` Full Usage: `Events.KeyboardKeyChangeEvent` Returns: `KeyboardKeyData Address`	Raised when a keyboard key is pressed or released. Returns: `KeyboardKeyData Address`
`Events.KeyboardKeyDownEvent` Full Usage: `Events.KeyboardKeyDownEvent` Returns: `KeyboardKeyData Address`	Raised when a keyboard key is pressed. Returns: `KeyboardKeyData Address`
`Events.KeyboardKeyUpEvent` Full Usage: `Events.KeyboardKeyUpEvent` Returns: `KeyboardKeyData Address`	Raised when a keyboard key is released. Returns: `KeyboardKeyData Address`
`Events.KeyedValueChangeEvent key` Full Usage: `Events.KeyedValueChangeEvent key` Parameters: key : `string` Returns: `KeyedValueChangeData Address`	Raised when a key-value pair is changed in the world. key : `string` Returns: `KeyedValueChangeData Address`
`Events.LifeCycleEvent simulantTypeName` Full Usage: `Events.LifeCycleEvent simulantTypeName` Parameters: simulantTypeName : `string` Returns: `LifeCycleEventData Address`	Raised when a simulant is registered, unregistered, or has its mounting state changed. simulantTypeName : `string` Returns: `LifeCycleEventData Address`
`Events.MountEvent` Full Usage: `Events.MountEvent` Returns: `MountData Address`	Raised when an entity is mounted. Returns: `MountData Address`
`Events.MouseDragEvent` Full Usage: `Events.MouseDragEvent` Returns: `MouseMoveData Address`	Raised when mouse movement occurs while a mouse button is down. Returns: `MouseMoveData Address`
`Events.MouseLeftChangeEvent` Full Usage: `Events.MouseLeftChangeEvent` Returns: `MouseButtonData Address`	Raised when the left mouse button is pressed or released. Returns: `MouseButtonData Address`
`Events.MouseLeftDownEvent` Full Usage: `Events.MouseLeftDownEvent` Returns: `MouseButtonData Address`	Raised when the left mouse button is pressed. Returns: `MouseButtonData Address`
`Events.MouseLeftUpEvent` Full Usage: `Events.MouseLeftUpEvent` Returns: `MouseButtonData Address`	Raised when the left mouse button is released. Returns: `MouseButtonData Address`
`Events.MouseMiddleChangeEvent` Full Usage: `Events.MouseMiddleChangeEvent` Returns: `MouseButtonData Address`	Raised when the middle mouse button is pressed or released. Returns: `MouseButtonData Address`
`Events.MouseMiddleDownEvent` Full Usage: `Events.MouseMiddleDownEvent` Returns: `MouseButtonData Address`	Raised when the middle mouse button is pressed. Returns: `MouseButtonData Address`
`Events.MouseMiddleUpEvent` Full Usage: `Events.MouseMiddleUpEvent` Returns: `MouseButtonData Address`	Raised when the middle mouse button is released. Returns: `MouseButtonData Address`
`Events.MouseMoveEvent` Full Usage: `Events.MouseMoveEvent` Returns: `MouseMoveData Address`	Raised when mouse movement occurs. Returns: `MouseMoveData Address`
`Events.MouseRightChangeEvent` Full Usage: `Events.MouseRightChangeEvent` Returns: `MouseButtonData Address`	Raised when the right mouse button is pressed or released. Returns: `MouseButtonData Address`
`Events.MouseRightDownEvent` Full Usage: `Events.MouseRightDownEvent` Returns: `MouseButtonData Address`	Raised when the right mouse button is pressed. Returns: `MouseButtonData Address`
`Events.MouseRightUpEvent` Full Usage: `Events.MouseRightUpEvent` Returns: `MouseButtonData Address`	Raised when the right mouse button is released. Returns: `MouseButtonData Address`
`Events.MouseWheelEvent` Full Usage: `Events.MouseWheelEvent` Returns: `MouseWheelData Address`	Raised when the mouse wheel is scrolled. Returns: `MouseWheelData Address`
`Events.MouseX1ChangeEvent` Full Usage: `Events.MouseX1ChangeEvent` Returns: `MouseButtonData Address`	Raised when the X1 mouse button is pressed or released. Returns: `MouseButtonData Address`
`Events.MouseX1DownEvent` Full Usage: `Events.MouseX1DownEvent` Returns: `MouseButtonData Address`	Raised when the X1 mouse button is pressed. Returns: `MouseButtonData Address`
`Events.MouseX1UpEvent` Full Usage: `Events.MouseX1UpEvent` Returns: `MouseButtonData Address`	Raised when the X1 mouse button is released. Returns: `MouseButtonData Address`
`Events.MouseX2ChangeEvent` Full Usage: `Events.MouseX2ChangeEvent` Returns: `MouseButtonData Address`	Raised when the X2 mouse button is pressed or released. Returns: `MouseButtonData Address`
`Events.MouseX2DownEvent` Full Usage: `Events.MouseX2DownEvent` Returns: `MouseButtonData Address`	Raised when the X2 mouse button is pressed. Returns: `MouseButtonData Address`
`Events.MouseX2UpEvent` Full Usage: `Events.MouseX2UpEvent` Returns: `MouseButtonData Address`	Raised when the X2 mouse button is released. Returns: `MouseButtonData Address`
`Events.OutgoingFinishEvent` Full Usage: `Events.OutgoingFinishEvent` Returns: `unit Address`	Raised when a screen has just finished transitioning out. Returns: `unit Address`
`Events.OutgoingStartEvent` Full Usage: `Events.OutgoingStartEvent` Returns: `unit Address`	Raised when a screen has just started transitioning out. Returns: `unit Address`
`Events.PostUpdateEvent` Full Usage: `Events.PostUpdateEvent` Returns: `unit Address`	Raised when post-update processing on a simulant occurs (except on entities for efficiency). Returns: `unit Address`
`Events.PreUpdateEvent` Full Usage: `Events.PreUpdateEvent` Returns: `unit Address`	Raised when pre-update processing on a simulant occurs (except on entities for efficiency). Returns: `unit Address`
`Events.RegisterEvent` Full Usage: `Events.RegisterEvent` Returns: `unit Address`	Raised when a simulant is registered. Returns: `unit Address`
`Events.SelectEvent` Full Usage: `Events.SelectEvent` Returns: `unit Address`	Raised when a screen is selected. Returns: `unit Address`
`Events.SpineSkeletonAnimationTriggerEvent` Full Usage: `Events.SpineSkeletonAnimationTriggerEvent` Returns: `SpineSkeletonAnimationTriggerData Address`	Raised when a Spine skeleton animation event is triggered. Returns: `SpineSkeletonAnimationTriggerData Address`
`Events.TextEditEvent` Full Usage: `Events.TextEditEvent` Returns: `TextEditData Address`	Raised when the content of a text gui is edited. Returns: `TextEditData Address`
`Events.TextInputEvent` Full Usage: `Events.TextInputEvent` Returns: `TextInputData Address`	Raised when text input is received from the OS. Returns: `TextInputData Address`
`Events.TimeUpdateEvent` Full Usage: `Events.TimeUpdateEvent` Returns: `unit Address`	Raised when the engine's representation of current time changes. Returns: `unit Address`
`Events.ToggleEvent` Full Usage: `Events.ToggleEvent` Returns: `bool Address`	Raised when a button is toggled. Returns: `bool Address`
`Events.ToggledEvent` Full Usage: `Events.ToggledEvent` Returns: `unit Address`	Raised when a button is pressed. Returns: `unit Address`
`Events.TouchEvent` Full Usage: `Events.TouchEvent` Returns: `Vector2 Address`	Raised while a feeler is touched. Returns: `Vector2 Address`
`Events.TouchingEvent` Full Usage: `Events.TouchingEvent` Returns: `Vector2 Address`	Raised when a feeler is initially touched. Returns: `Vector2 Address`
`Events.UndialedEvent` Full Usage: `Events.UndialedEvent` Returns: `unit Address`	Raised when a dial is released. Returns: `unit Address`
`Events.UnmountEvent` Full Usage: `Events.UnmountEvent` Returns: `MountData Address`	Raised when an entity is unmounted. Returns: `MountData Address`
`Events.UnregisteringEvent` Full Usage: `Events.UnregisteringEvent` Returns: `unit Address`	Raised when a simulant is unregistered. Returns: `unit Address`
`Events.UntoggledEvent` Full Usage: `Events.UntoggledEvent` Returns: `unit Address`	Raised when a button is released. Returns: `unit Address`
`Events.UntouchEvent` Full Usage: `Events.UntouchEvent` Returns: `Vector2 Address`	Raised when a feeler is no longer touched. Returns: `Vector2 Address`
`Events.UpEvent` Full Usage: `Events.UpEvent` Returns: `unit Address`	Raised when a button is released. Returns: `unit Address`
`Events.UpdateEvent` Full Usage: `Events.UpdateEvent` Returns: `unit Address`	Raised when update processing on a simulant occurs (except on entities for efficiency). Returns: `unit Address`