SpaceVIL.Decorations.Effects Class Reference

Effects is a static class for controlling the application of effects to a item's shape. More...

Static Public Member Functions
static void	AddEffect (IBaseItem item, IEffect effect)
	Adding effect to specified item. More...
static bool	RemoveEffect (IBaseItem item, IEffect effect)
	Removing specified effect form item. More...
static List< IEffect >	GetEffects (IBaseItem item)
	Getting list of applyed effects on specified item. More...

Detailed Description

Effects is a static class for controlling the application of effects to a item's shape.

Member Function Documentation

AddEffect()

static void SpaceVIL.Decorations.Effects.AddEffect ( IBaseItem  item, IEffect  effect  )

static

Adding effect to specified item.

Parameters

item	A item as SpaceVIL.Core.IBaseItem.
effect	A effect as SpaceVIL.Core.IEffect.

GetEffects()

static List<IEffect> SpaceVIL.Decorations.Effects.GetEffects ( IBaseItem  item )

static

Getting list of applyed effects on specified item.

Parameters

item	An item as SpaceVIL.Core.IBaseItem.

Returns

List of effects of specified item as List<SpaceVIL.Core.IEffect>.

RemoveEffect()

static bool SpaceVIL.Decorations.Effects.RemoveEffect ( IBaseItem  item, IEffect  effect  )

static

Removing specified effect form item.

Parameters

item	A item as SpaceVIL.Core.IBaseItem.
effect	A effect as SpaceVIL.Core.IEffect.

Returns

True: if such effect is presented and removed. False: if item has no such effect.

---

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

• Effects.cs