Otter.Flash Class Reference

Entity that acts as a screen flash. Best used when using the constructor that allows for initial parameters be set: Flash(Color.Red) { Alpha = 0.5, Blend = BlendMode.Add }; More...

Inherits Otter.Entity.

Public Member Functions
	Flash (Color color)
	Create a new Flash. More...
override void	Added ()
	Added to the Scene. More...
override void	Update ()
	Updated. More...
override void	Removed ()
	Removed from the Scene. More...
Public Member Functions inherited from Otter.Entity
	Entity (float x=0, float y=0, Graphic graphic=null, Collider collider=null, string name="")
	Create an entity. More...
void	SetGraphic (Graphic g)
	Sets the graphic to a new graphic, removing all previous graphics. More...
void	SetPosition (float xy)
	Set the X and Y position to a value. More...
void	AddPosition (float x, float y)
	Add to the X and Y positions of the Entity. More...
void	AddPosition (Axis axis, float multiplier=1)
	Add to the X and Y position of the Entity. More...
void	AddPosition (Vector2 vector)
	Add to the X and Y position of the Entity. More...
void	SetPosition (float x, float y)
	Set the position of the Entity. More...
void	SetPosition (Entity e, float offsetX=0, float offsetY=0)
	Set the position of the Entity to another Entity's position. More...
void	SetPosition (Vector2 v)
	Set the position of the Entity. More...
T	AddGraphic< T > (T g)
	Adds a Graphic to the Entity. More...
T	AddGraphic< T > (T g, float x, float y)
	Adds a Graphic to the Entity. More...
List< Graphic >	AddGraphics (params Graphic[] graphics)
	Adds the graphics to the Entity. More...
T	AddGraphicGUI< T > (T g)
	Adds a graphic to the Entity and sets its Scroll value to 0. More...
T	AddGraphicGUI< T > (T g, float x, float y)
	Adds a graphic to the Entity and sets its Scroll value to 0. More...
List< Graphic >	AddGraphicsGUI (params Graphic[] graphics)
	Adds Graphics to the Entity and sets their Scroll values to 0. More...
T	RemoveGraphic< T > (T g)
	Removes a Graphic from the Entity. More...
void	RemoveGraphics (params Graphic[] g)
	Removes Graphics from the Entity. More...
void	ClearGraphics ()
	Remove all the graphics from the entity. More...
T	AddComponent< T > (T c)
	Adds a component to the entity. More...
T	AddComponent< T > (params object[] constructorArgs)
	Creates and adds a Component to the entity. More...
List< Component >	AddComponents (params Component[] c)
	Add multiple components to the entity. More...
T	RemoveComponent< T > (T c)
	Removes a component from the Entity. More...
T	RemoveComponent< T > ()
	Removes the first component of type T from the Entity. More...
void	ClearComponents ()
	Remove all components from the Entity. More...
void	AddSurface (Surface target)
	Add a surface that the entity should render to. More...
void	RemoveSurface (Surface target)
	Remove a surface from the list of surfaces that the entity should render to. More...
void	ClearSurfaces ()
	Remove all Surfaces from the list of Surfaces that the Entity should render to. More...
BoxCollider	SetHitbox (int width, int height, params int[] tags)
	Shortcut to set the Collider of the entity to a BoxCollider. Using this will set the "Hitbox" field to this Collider. More...
BoxCollider	SetHitbox (int width, int height, Enum tag, params Enum[] tags)
	Shortcut to set the Collider of the entity to a BoxCollider. Using this will set the "Hitbox" field to this Collider. More...
T	GetEntity< T > ()
	Get the first instance of an Entity of type T in this Entity's Scene. More...
List< T >	GetEntities< T > ()
	Get a list of entities of type T from this Entity's Scene. More...
T	GetComponent< T > ()
	Get the first Component of type T. More...
Component	GetComponent (Type type)
	Get the first Component of Type type. More...
List< T >	GetComponents< T > ()
	Get all Components of type T. More...
T	GetGraphic< T > ()
	Get the first graphic of type T. More...
T	GetCollider< T > ()
	Get the first collider of type T. More...
T	AddCollider< T > (T c)
	Add a collider to the entity. More...
T	RemoveCollider< T > (T c)
	Remove the collider from the entity. More...
void	ClearColliders ()
	Remove all colliders from the entity. More...
T	SetCollider< T > (T c)
	Remove all current colliders and set collider to a new one. More...
List< Collider >	AddColliders (params Collider[] colliders)
	Adds colliders to the entity. More...
void	RemoveColliders (params Collider[] colliders)
	Removes colliders from the entity. More...
Collider	Collide (float x, float y, params int[] tags)
	Checks for a collision using the first available Collider. More...
Collider	Collide (float x, float y, params Enum[] tags)
	Checks for a collision using the first available Collider. More...
List< Collider >	CollideList (float x, float y, params int[] tags)
	Checks for a collision with the first available Collider. More...
List< Collider >	CollideList (float x, float y, params Enum[] tags)
	Checks for a collision with the first available Collider. More...
List< Entity >	CollideEntities (float x, float y, params int[] tags)
	Checks for a collision with the first available Collider. More...
List< Entity >	CollideEntities (float x, float y, params Enum[] tags)
	Checks for a collision with the first available Collider. More...
List< T >	CollideEntities< T > (float x, float y, List< T > entities)
List< T >	CollideEntities< T > (float x, float y, params int[] tags)
List< T >	CollideEntities< T > (float x, float y, params Enum[] tags)
bool	Overlap (float x, float y, params int[] tags)
	Checks for an overlap using the first available collider. More...
bool	Overlap (float x, float y, params Enum[] tags)
	Checks for an overlap using the first available collider. More...
bool	Overlap (float x, float y, Entity e)
	Checks for an overlap using the first available collider. More...
virtual void	SceneBegin ()
	Called when the Scene begins. More...
virtual void	SceneEnd ()
	Called when the Scene ends. More...
virtual void	ScenePause ()
	Called when the Scene is paused. More...
virtual void	SceneResume ()
	Called when the Scene is resumed. More...
virtual void	Paused ()
	Called when the entity is paused by the Scene. More...
virtual void	Resumed ()
	Called when the entity is resumed by the Scene. More...
Tween	Tween (object target, object values, float duration, float delay=0)
	Tweens a set of numeric properties on an object. More...
virtual void	UpdateFirst ()
	Called first during the update. Happens before Update. More...
virtual void	UpdateLast ()
	Called last during the update. Happens after Update. More...
virtual void	Render ()
	Called when the entity is rendering to the screen. More...
virtual void	Prerender ()
	Called before an entity is rendered. Things rendered here will appear below the Entity's Graphics. More...
void	RemoveSelf ()
	Remove this entity from the Scene it's in. More...

Public Attributes
Color	Color
	The Color for the Flash. More...
float	Alpha = 1
	The initial alpha for the Flash. More...
float	FinalAlpha = 0
	The final alpha for the Flash. More...
BlendMode	Blend = BlendMode.Alpha
	The BlendMode for the Flash. More...
Public Attributes inherited from Otter.Entity
float	X
	The X position of the Entity. More...
float	Y
	The Y position of the Entity. More...
float	Timer
	How long the Entity has been active. More...
bool	Visible = true
	Determines if the Entity will render. More...
bool	Collidable = true
	Determines if the Entity will collide with other entities. The entity can still check for collisions, but will not register as a collision with other entities. More...
bool	AutoUpdate = true
	Deteremines if the Entity's update functions will run automatically from the Scene. More...
bool	AutoRender = true
	Determines if the Entity's render functions will run automatically from the Scene. More...
Tweener	Tweener = new Tweener()
	The tween manager that controls all tweens on this entity. More...
Action	OnAdded = delegate { }
	An action that fires when the entity is added to a Scene. More...
Action	OnUpdate = delegate { }
	An action that fires when the entity is updated. More...
Action	OnUpdateFirst = delegate { }
	An action that fires in the entity's UpdateFirst(). More...
Action	OnUpdateLast = delegate { }
	An action that is fired in the entity's UpdateLast(). More...
Action	OnRemoved = delegate { }
	An action that fires when the entity is removed from a Scene. More...
Action	OnRender = delegate { }
	An action that fires when the entity is rendered. More...
string	Name
	The name of this entity. Default's to the Type name. More...
int	Layer
	The order in which to render this entity. Higher numbers draw later. More...
int	Order
	The order in which to update this entity. Higher numbers update later. More...
int	Group
	The pause group this entity is a part of. More...
float	LifeSpan
	How long the entity should live in the scene before removing itself. If this is set the entity will be automatically removed when the Timer exceeds this value. More...

Static Public Attributes
static int	DefaultLifeSpan = 60
	The default life span for all created Flash Entities. More...

Additional Inherited Members
Properties inherited from Otter.Entity
bool	UpdatedOnce [get, set]
	Is true if the Entity has been updated by the Scene at least once. More...
Component	this[int id] [get]
List< Graphic >	Graphics [get, set]
	The list of graphics to render. More...
List< Component >	Components [get, set]
	The list of components to update and render. More...
List< Collider >	Colliders [get, set]
	The list of colliders to use for collision checks. More...
List< Surface >	Surfaces [get, set]
	The list of surfaces the entity should draw to. More...
Scene	Scene [get, set]
	The Scene that controls and updates this entity. More...
int	InstanceId [get, set]
	The int id of the Entity for the Scene its currently in. More...
bool	IsInScene [get]
	Returns true if the entity is currently in a Scene, or is queued to be added to a Scene next update. More...
Surface	Surface [get, set]
	The default Surface that the entity should render to. More...
Entity	Overlapped [get, set]
	The currently overlapped entity. This only works when using an Overlap collision check, and there is a result. More...
BoxCollider	Hitbox [get, set]
	Set to a collider by using the SetHitbox method. Shortcut reference. More...
Collider	Collider [get, set]
	Returns the first available collider, or set the Collider. More...
Input	Input [get]
	A reference to the Input object in the Game that controls the Scene. More...
Game	Game [get]
	A reference to the Game that controls the Scene. More...
bool	IsPaused [get]
	If the entity is currently paused by the scene. More...
float	ScreenX [get]
	The x position in screen space of the entity. More...
float	ScreenY [get]
	The y position in screen space of the entity. More...
Graphic	Graphic [get, set]
	Returns the first available graphic, or set the graphic. More...
Vector2	Position [get, set]
	The position of the Entity represented as a Vector2 More...

Detailed Description

Entity that acts as a screen flash. Best used when using the constructor that allows for initial parameters be set: Flash(Color.Red) { Alpha = 0.5, Blend = BlendMode.Add };

Constructor & Destructor Documentation

Otter.Flash.Flash

(

Color

color

)

Create a new Flash.

Parameters

color

The Color of the Flash.

Member Function Documentation

override void Otter.Flash.Added ( )

virtual

Added to the Scene.

Reimplemented from Otter.Entity.

override void Otter.Flash.Removed ( )

virtual

Removed from the Scene.

Reimplemented from Otter.Entity.

override void Otter.Flash.Update ( )

virtual

Updated.

Reimplemented from Otter.Entity.

Member Data Documentation

float Otter.Flash.Alpha = 1

The initial alpha for the Flash.

BlendMode Otter.Flash.Blend = BlendMode.Alpha

The BlendMode for the Flash.

Color Otter.Flash.Color

The Color for the Flash.

int Otter.Flash.DefaultLifeSpan = 60

static

The default life span for all created Flash Entities.

float Otter.Flash.FinalAlpha = 0

The final alpha for the Flash.

---

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

• Otter/Utility/Entities/Flash.cs