Otter.LineCollider Class Reference

Line Collider. More...

Inherits Otter.Collider.

Public Member Functions
	LineCollider (float x1, float y1, float x2, float y2, params int[] tags)
	Create a LineCollider. More...
	LineCollider (float x1, float y1, float x2, float y2, Enum tag, params Enum[] tags)
override void	Render (Color color=null)
	Draw the collider for debug purposes. More...
Public Member Functions inherited from Otter.Collider
bool	Overlap (float x, float y, int px, int py)
	Checks for a collision with a specific point. More...
bool	Overlap (float x, float y, params int[] tags)
	Checks for a collision against the specified tags and returns true or false. More...
bool	Overlap (float x, float y, Collider c)
	Checks for a collision against a specific Collider and returns true or false. More...
bool	Overlap (float x, float y, Entity e)
	Checks for a collision against a specific Entity and returns true or false. More...
bool	Overlap (float x, float y, List< int > tags)
	Checks for a collision against a list of Collliders and returns true or false. More...
bool	Overlap (float x, float y, params Enum[] tags)
	Checks for a collision against the specified tags and returns true or false. More...
bool	Overlap (float x, float y, List< Enum > tags)
	Checks for a collision against the specified tags and returns true or false. More...
bool	Overlap (float x, float y, List< Entity > entities)
	Checks for a collision against a list of Entities and all of their colliders. More...
bool	Overlap< T > (float x, float y, List< T > entities)
	Checks for a collision against a list of Entities and all of their colliders. More...
Collider	Collide (float x, float y, List< Entity > entities)
	Checks for a collision against a list of Entities and all of their colliders. More...
Collider	Collide< T > (float x, float y, List< T > entities)
Collider	Collide (float x, float y, params int[] tags)
	Checks for a collision against specified tags. More...
Collider	Collide (float x, float y, params Enum[] tags)
	Checks for a collision against specified tags. More...
Collider	Collide (float x, float y, Collider c)
	Checks for a collision with a specific collider. More...
Collider	Collide (float x, float y, Entity e)
	Checks for a collision with a specific entity. More...
Collider	Collide (float x, float y, List< int > tags)
	Checks for a collision with a list of tags. More...
Collider	Collide (float x, float y, List< Enum > tags)
	Checks for a collision with a list of tags. More...
Entity	CollideEntity (float x, float y, params int[] tags)
	Checks for a collision with a list of tags and returns an Entity. More...
T	CollideEntity< T > (float x, float y, params int[] tags)
	Checks for a collision with a list of tags and returns an Entity. More...
Entity	CollideEntity (float x, float y, params Enum[] tags)
	Checks for a collision with a list of tags and returns an Entity. More...
T	CollideEntity< T > (float x, float y, params Enum[] tags)
	Checks for a collision with a list of tags and returns an Entity. More...
Entity	CollideEntity (float x, float y, Entity e)
	Checks for a collision with a specific Entity and returns an Entity. More...
T	CollideEntity< T > (float x, float y, Entity e)
	Checks for a collision with a specific Entity and returns an Entity. More...
Entity	CollideEntity (float x, float y, Collider c)
	Checks for a collision with a specific Collider and returns an Entity. More...
T	CollideEntity< T > (float x, float y, Collider c)
	Checks for a collision with a specific Collider and returns an Entity. More...
Entity	CollideEntity (float x, float y, List< int > tags)
	Checks for a collision with a list of tags and returns an Entity. More...
T	CollideEntity< T > (float x, float y, List< int > tags)
	Checks for a collision with a list of tags and returns an Entity. More...
Entity	CollideEntity (float x, float y, List< Entity > entities)
	Checks for a collision with a list of Entities and returns an Entity. More...
T	CollideEntity< T > (float x, float y, List< T > entities)
	Checks for a collision with a list of Entities and returns an Entity. More...
List< Collider >	CollideList (float x, float y, params int[] tags)
	Creates a list of Colliders that this Collider is colliding with. More...
List< Collider >	CollideList (float x, float y, params Enum[] tags)
	Creates a list of Colliders that this Collider is colliding with. More...
List< Collider >	CollideList (float x, float y, List< Enum > tags)
	Creates a list of Colliders that this Collider is colliding with. More...
List< Collider >	CollideList (float x, float y, List< int > tags)
	Creates a list of Colliders that this Collider is colliding with. More...
List< Entity >	CollideEntities (float x, float y, params int[] tags)
	Creates a list of Entities that the Collider has collided with. More...
List< Entity >	CollideEntities (float x, float y, params Enum[] tags)
	Creates a list of Entities that the Collider has collided with. More...
List< Entity >	CollideEntities (float x, float y, List< Enum > tags)
	Creates a list of Entities that the Collider has collided with. More...
List< T >	CollideEntities< T > (float x, float y, params int[] tags)
	Creates a list of Entities that the Collider has collided with. More...
List< T >	CollideEntities< T > (float x, float y, params Enum[] tags)
	Creates a list of Entities that the Collider has collided with. More...
List< T >	CollideEntities< T > (float x, float y, List< Enum > tags)
	Creates a list of Entities that the Collider has collided with. More...
List< T >	CollideEntities< T > (float x, float y, List< T > entities)
	Creates a list of Entities that the Collider has collided with. More...
List< Entity >	CollideEntities (float x, float y, List< int > tags)
	Creates a list of entities that the Collider has collided with. More...
virtual void	Added ()
	Callback for when the Collider has been added to an Entity. More...
virtual void	Removed ()
	Callback for when the Collider has been removed from an Entity. More...
Collider	AddTag (int tag)
	Add a new tag to the Collider. More...
Collider	AddTag (params Enum[] tags)
	Add new tags to the Collider. More...
bool	HasTag (params Enum[] tags)
bool	HasTag (params int[] tags)
Collider	AddTag (params int[] tags)
	Add new tags to the Collider. More...
Collider	RemoveTag (int tag)
	Remove a tag from the Collider. More...
Collider	RemoveTag (params int[] tags)
	Remove tags from the Collider. More...
Collider	RemoveTag (params Enum[] tags)
	Remove tags from the Collider. More...
virtual void	CenterOrigin ()
	Center the origin of the Collider. Based off of Width and Height. More...
void	SetPosition (float x, float y)
	Set the positon of the Collider. More...
void	SetPosition (Vector2 xy)
	Set the position of the Collider. More...
void	SetOrigin (float x, float y)
	Set the origin of the Collider More...
void	SetOrigin (Vector2 xy)
	Set the origin of the Collider. More...

Public Attributes
float	X2
	The X position of the end of the line. More...
float	Y2
	The Y position of the end of the line. More...
Public Attributes inherited from Otter.Collider
float	X
	The X position of the Collider relative to the Entity. More...
float	Y
	The Y position of the Collider relative to the Entity. More...
float	OriginX
	The OriginX of the Collider. More...
float	OriginY
	The OriginY of the Collider. More...
Entity	Entity
	The entity that this collider is parented to. More...
bool	Collidable = true
	Determines if this collider is collidable. If false, it will not register collisions with other colliders, but can still check for collisions with other colliders. More...

Properties
override float	Width [get]
	The width of the area the line occupies. More...
override float	Height [get]
	The height of the area the line occupies. More...
override float	Bottom [get]
	The bottom most Y position of the line. More...
override float	Top [get]
	The top most Y position of the line. More...
override float	Left [get]
	The left most X position of the line. More...
override float	Right [get]
	The right most X position of the line. More...
Line2	Line2 [get]
	Convert the LineCollider into a Line2 object. More...
Properties inherited from Otter.Collider
List< int >	Tags [get, set]
	The tags that this Collider is registered with. More...
virtual float	Width [get, set]
	The width of the Collider. More...
virtual float	Height [get, set]
	The height of the Collider. More...
virtual float	CenterX [get]
	The X position of the center of the Collider. More...
virtual float	CenterY [get]
	The Y position of the center of the Collider. More...
virtual float	Left [get]
	The X position of the left side of the Collider. More...
virtual float	Right [get]
	The X position of the right side of the Collider. More...
virtual float	Top [get]
	The Y position of the top of the Collider. More...
virtual float	Bottom [get]
	The Y position of the bottom of the Collider. More...
float	HalfHeight [get]
	Half of the Collider's height. More...
float	HalfWidth [get]
	Half of the Collider's width. More...

Detailed Description

Line Collider.

Constructor & Destructor Documentation

Otter.LineCollider.LineCollider	(	float	x1,
		float	y1,
		float	x2,
		float	y2,
		params int[]	tags
	)

Create a LineCollider.

Parameters

x1	The X position of the start of the line.
y1	The Y position of the start of the line.
x2	The X position of the end of the line.
y2	The X position of the end of the line.
tags	The tags to register for the Collider.

Member Function Documentation

override void Otter.LineCollider.Render ( Color  color = null )

virtual

Draw the collider for debug purposes.

Reimplemented from Otter.Collider.

Member Data Documentation

float Otter.LineCollider.X2

The X position of the end of the line.

float Otter.LineCollider.Y2

The Y position of the end of the line.

Property Documentation

override float Otter.LineCollider.Bottom

get

The bottom most Y position of the line.

override float Otter.LineCollider.Height

get

The height of the area the line occupies.

override float Otter.LineCollider.Left

get

The left most X position of the line.

Line2 Otter.LineCollider.Line2

get

Convert the LineCollider into a Line2 object.

override float Otter.LineCollider.Right

get

The right most X position of the line.

override float Otter.LineCollider.Top

get

The top most Y position of the line.

override float Otter.LineCollider.Width

get

The width of the area the line occupies.

---

The documentation for this class was generated from the following file:

• Otter/Colliders/LineCollider.cs