MoreMountains.CorgiEngine.MMDoubleSpriteMask Class Reference

This setup uses two sprite masks, bound in the inspector, to enable one and then disable the other to mask specific parts of a level More...

Inheritance diagram for MoreMountains.CorgiEngine.MMDoubleSpriteMask:

Public Member Functions
virtual void	OnMMEvent (MMSpriteMaskEvent spriteMaskEvent)
	When we catch a double mask event, we handle it More...
Public Member Functions inherited from MoreMountains.Tools.MMEventListener< MMSpriteMaskEvent >
void	OnMMEvent (T eventType)

Public Attributes
MMSpriteMask	Mask1
	the first sprite mask More...
MMSpriteMask	Mask2
	the second sprite mask More...

Protected Member Functions
virtual void	Awake ()
	On awake we initialize our masks More...
virtual void	SwitchCurrentMask ()
	Sets new values for current and dormant masks More...
virtual IEnumerator	DoubleMaskCo (MMSpriteMaskEvent spriteMaskEvent)
	A coroutine designed to mask the first mask after having activated and moved the dormant one to the new position More...
virtual void	OnEnable ()
	On enable we start listening for events More...
virtual void	OnDisable ()
	On disable we stop listening for events More...

Protected Attributes
MMSpriteMask	_currentMask
MMSpriteMask	_dormantMask

Detailed Description

This setup uses two sprite masks, bound in the inspector, to enable one and then disable the other to mask specific parts of a level

Member Function Documentation

Awake()

virtual void MoreMountains.CorgiEngine.MMDoubleSpriteMask.Awake ( )

protectedvirtual

On awake we initialize our masks

DoubleMaskCo()

virtual IEnumerator MoreMountains.CorgiEngine.MMDoubleSpriteMask.DoubleMaskCo ( MMSpriteMaskEvent  spriteMaskEvent )

protectedvirtual

A coroutine designed to mask the first mask after having activated and moved the dormant one to the new position

Parameters

spriteMaskEvent

Returns

OnDisable()

virtual void MoreMountains.CorgiEngine.MMDoubleSpriteMask.OnDisable ( )

protectedvirtual

On disable we stop listening for events

OnEnable()

virtual void MoreMountains.CorgiEngine.MMDoubleSpriteMask.OnEnable ( )

protectedvirtual

On enable we start listening for events

OnMMEvent()

virtual void MoreMountains.CorgiEngine.MMDoubleSpriteMask.OnMMEvent ( MMSpriteMaskEvent  spriteMaskEvent )

virtual

When we catch a double mask event, we handle it

Parameters

spriteMaskEvent

SwitchCurrentMask()

virtual void MoreMountains.CorgiEngine.MMDoubleSpriteMask.SwitchCurrentMask ( )

protectedvirtual

Sets new values for current and dormant masks

Member Data Documentation

_currentMask

MMSpriteMask MoreMountains.CorgiEngine.MMDoubleSpriteMask._currentMask

protected

_dormantMask

MMSpriteMask MoreMountains.CorgiEngine.MMDoubleSpriteMask._dormantMask

protected

Mask1

MMSpriteMask MoreMountains.CorgiEngine.MMDoubleSpriteMask.Mask1

the first sprite mask

Mask2

MMSpriteMask MoreMountains.CorgiEngine.MMDoubleSpriteMask.Mask2

the second sprite mask

---

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

• Assets/CorgiEngine/Common/Scripts/Sprites/MMDoubleSpriteMask.cs