Show / Hide Table of Contents

Class HUDCompass

Compass for HUD.

Inheritance
Object
BaseScreenComponent
HUDCompass
Inherited Members
BaseScreenComponent.rectRestrictedRenderArea
BaseScreenComponent.restrictedRenderAreaCustomParent
BaseScreenComponent.restrictedRenderAreaCoordinateType
BaseScreenComponent.backgroundTexture
BaseScreenComponent.animatedBackgroundTextures
BaseScreenComponent.backgroundTextureLayout
BaseScreenComponent.OnKeyboardEvent
BaseScreenComponent.OnMouseEnter
BaseScreenComponent.OnMouseLeave
BaseScreenComponent.OnMouseMove
BaseScreenComponent.OnMouseDown
BaseScreenComponent.OnMouseUp
BaseScreenComponent.OnMouseClick
BaseScreenComponent.OnMouseDoubleClick
BaseScreenComponent.OnRightMouseDown
BaseScreenComponent.OnRightMouseUp
BaseScreenComponent.OnRightMouseClick
BaseScreenComponent.OnRightMouseDoubleClick
BaseScreenComponent.OnMiddleMouseDown
BaseScreenComponent.OnMiddleMouseUp
BaseScreenComponent.OnMiddleMouseClick
BaseScreenComponent.OnMiddleMouseDoubleClick
BaseScreenComponent.OnMouseScrollUp
BaseScreenComponent.OnMouseScrollDown
BaseScreenComponent.Enabled
BaseScreenComponent.UseFocus
BaseScreenComponent.OverridesHotkeySequences
BaseScreenComponent.Name
BaseScreenComponent.Tag
BaseScreenComponent.Position
BaseScreenComponent.Size
BaseScreenComponent.RootSize
BaseScreenComponent.Parent
BaseScreenComponent.Rectangle
BaseScreenComponent.HorizontalAlignment
BaseScreenComponent.VerticalAlignment
BaseScreenComponent.RestrictedRenderAreaCoordinateType
BaseScreenComponent.RectRestrictedRenderArea
BaseScreenComponent.RestrictedRenderAreaCustomParent
BaseScreenComponent.UseRestrictedRenderArea
BaseScreenComponent.CustomMousePosition
BaseScreenComponent.MousePosition
BaseScreenComponent.LastMousePosition
BaseScreenComponent.ScaledMousePosition
BaseScreenComponent.BackgroundColor
BaseScreenComponent.MouseOverBackgroundColor
BaseScreenComponent.BackgroundColorTexture
BaseScreenComponent.BackgroundTexture
BaseScreenComponent.BackgroundCroppedRect
BaseScreenComponent.AnimatedBackgroundTextures
BaseScreenComponent.AnimationDelayInSeconds
BaseScreenComponent.BackgroundTextureLayout
BaseScreenComponent.InteriorWidth
BaseScreenComponent.InteriorHeight
BaseScreenComponent.Scale
BaseScreenComponent.AutoSize
BaseScreenComponent.LocalScale
BaseScreenComponent.ToolTip
BaseScreenComponent.ToolTipText
BaseScreenComponent.SuppressToolTip
BaseScreenComponent.MinAutoScale
BaseScreenComponent.MaxAutoScale
BaseScreenComponent.MouseOverComponent
BaseScreenComponent.TopMargin
BaseScreenComponent.BottomMargin
BaseScreenComponent.LeftMargin
BaseScreenComponent.RightMargin
BaseScreenComponent.ScreenToLocal(Vector2)
BaseScreenComponent.ScreenToLocal(Rect)
BaseScreenComponent.GotFocus()
BaseScreenComponent.LostFocus()
BaseScreenComponent.TriggerMouseClick()
BaseScreenComponent.KeyboardEvent(Event)
BaseScreenComponent.MouseClick(Vector2)
BaseScreenComponent.RightMouseClick(Vector2)
BaseScreenComponent.MiddleMouseClick(Vector2)
BaseScreenComponent.MouseDoubleClick(Vector2)
BaseScreenComponent.RightMouseDoubleClick(Vector2)
BaseScreenComponent.MiddleMouseDoubleClick(Vector2)
BaseScreenComponent.MouseEnter()
BaseScreenComponent.MouseLeave(BaseScreenComponent)
BaseScreenComponent.MouseMove(Int32, Int32)
BaseScreenComponent.MouseScrollUp()
BaseScreenComponent.MouseScrollDown()
BaseScreenComponent.Dispose()
BaseScreenComponent.SetMargins(Margins, Int32)
BaseScreenComponent.OffsetFrom(BaseScreenComponent, Sides, Int32)
BaseScreenComponent.SetFocus()
BaseScreenComponent.HasFocus()
Namespace: DaggerfallWorkshop.Game.UserInterface
Assembly: Assembly-CSharp.dll
Syntax
public class HUDCompass : BaseScreenComponent, IDisposable

Constructors

| Improve this Doc View Source

HUDCompass()

Declaration
public HUDCompass()
| Improve this Doc View Source

HUDCompass(Camera)

Declaration
public HUDCompass(Camera camera)
Parameters
Type Name Description
Camera camera

Properties

| Improve this Doc View Source

CompassCamera

Gets or sets a compass camera to automatically determine compass heading.

Declaration
public Camera CompassCamera { get; set; }
Property Value
Type Description
Camera
| Improve this Doc View Source

EulerAngle

Gets or a sets a Euler angle to use for compass heading. This value is only observed when CompassCamera is null.

Declaration
public float EulerAngle { get; set; }
Property Value
Type Description
Single

Methods

| Improve this Doc View Source

DeregisterDetector(DetectEffect)

Deregister a DetectEffect instance from compass. Compass will also expire effect once it has ended, but deregistering will remove markers immediately.

Declaration
public void DeregisterDetector(DetectEffect detectEffect)
Parameters
Type Name Description
DetectEffect detectEffect
| Improve this Doc View Source

Draw()

Declaration
public override void Draw()
Overrides
BaseScreenComponent.Draw()
| Improve this Doc View Source

RegisterDetector(DetectEffect)

Register a DetectEffect instance with compass.

Declaration
public void RegisterDetector(DetectEffect detectEffect)
Parameters
Type Name Description
DetectEffect detectEffect

DetectEffect to register.

| Improve this Doc View Source

Update()

Declaration
public override void Update()
Overrides
BaseScreenComponent.Update()
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX