Class ClickableComponent

Inheritance

System.Object

ClickableComponent

Namespace: Content.Client.Clickable

Assembly: Content.Client.dll

Syntax

public sealed class ClickableComponent : Component

Fields

Bounds

Declaration

public ClickableComponent.DirBoundData Bounds

Field Value

Type	Description
ClickableComponent.DirBoundData

Methods

CheckClick(SpriteComponent, TransformComponent, EntityQuery<TransformComponent>, Vector2, IEye, out Int32, out UInt32, out Single)

Used to check whether a click worked. Will first check if the click falls inside of some explicit bounding boxes (see Bounds). If that fails, attempts to use automatically generated click maps.

Declaration

public bool CheckClick(SpriteComponent sprite, TransformComponent transform, EntityQuery<TransformComponent> xformQuery, Vector2 worldPos, IEye eye, out int drawDepth, out uint renderOrder, out float bottom)

Parameters

Type	Name	Description
Robust.Client.GameObjects.SpriteComponent	sprite
TransformComponent	transform
EntityQuery<TransformComponent>	xformQuery
Vector2	worldPos	The world position that was clicked.
Robust.Shared.Graphics.IEye	eye
System.Int32	drawDepth	The draw depth for the sprite that captured the click.
System.UInt32	renderOrder
System.Single	bottom

Returns

Type	Description
System.Boolean	True if the click worked, false otherwise.

CheckDirBound(SpriteComponent, Angle, Vector2)

Declaration

public bool CheckDirBound(SpriteComponent sprite, Angle relativeRotation, Vector2 localPos)

Parameters

Type	Name	Description
Robust.Client.GameObjects.SpriteComponent	sprite
Angle	relativeRotation
Vector2	localPos

Returns

Type	Description
System.Boolean