MoreMountains.TopDownEngine.DeadlineStar Class Reference

A pickable star, that triggers an event if picked, and disables itself if it's been previously collected. More...

Inheritance diagram for MoreMountains.TopDownEngine.DeadlineStar:

Protected Member Functions
override void	Start ()
	On Start we disable our star if needed.
virtual void	DisableIfAlreadyCollected ()
	Disables the star if it's already been collected in the past.
virtual void	Disable ()
	Disable this star.
Protected Member Functions inherited from MoreMountains.TopDownEngine.Star
override void	Pick (GameObject picker)
	Triggered when something collides with the star.
Protected Member Functions inherited from MoreMountains.TopDownEngine.PickableItem
virtual IEnumerator	DisableTargetObjectCoroutine ()
virtual IEnumerator	DisablePickerCoroutine ()
virtual bool	CheckIfPickable ()
	Checks if the object is pickable.
virtual void	Effects ()
	Triggers the various pick effects.

Additional Inherited Members
Public Member Functions inherited from MoreMountains.TopDownEngine.PickableItem
virtual void	OnTriggerEnter (Collider collider)
	Triggered when something collides with the coin.
virtual void	OnTriggerEnter2D (Collider2D collider)
	Triggered when something collides with the coin.
virtual void	PickItem (GameObject picker)
	Check if the item is pickable and if yes, proceeds with triggering the effects and disabling the object.
Public Attributes inherited from MoreMountains.TopDownEngine.Star
int	StarID
	the ID of this star, used by the progress manager to know which one got unlocked
Public Attributes inherited from MoreMountains.TopDownEngine.PickableItem
MMFeedbacks	PickedMMFeedbacks
	A feedback to play when the object gets picked.
bool	DisableColliderOnPick = false
	if this is true, the picker's collider will be disabled on pick
bool	DisableObjectOnPick = true
	if this is set to true, the object will be disabled when picked
float	DisableDelay = 0f
	the duration (in seconds) after which to disable the object, instant if 0
bool	DisableModelOnPick = false
	if this is set to true, the object will be disabled when picked
bool	DisableTargetObjectOnPick = false
	if this is set to true, the target object will be disabled when picked
GameObject	TargetObjectToDisable
	the object to disable on pick if DisableTargetObjectOnPick is true
float	TargetObjectDisableDelay = 1f
	the time in seconds before disabling the target if DisableTargetObjectOnPick is true
GameObject	Model
	the visual representation of this picker
bool	RequireCharacterComponent = true
	if this is true, this pickable item will only be pickable by objects with a Character component
bool	RequirePlayerType = true
	if this is true, this pickable item will only be pickable by objects with a Character component of type player
Protected Attributes inherited from MoreMountains.TopDownEngine.PickableItem
Collider	_collider
Collider2D	_collider2D
GameObject	_collidingObject
Character	_character = null
bool	_pickable = false
ItemPicker	_itemPicker = null
WaitForSeconds	_disableDelay

Detailed Description

A pickable star, that triggers an event if picked, and disables itself if it's been previously collected.

Member Function Documentation

Disable()

virtual void MoreMountains.TopDownEngine.DeadlineStar.Disable ( )

protectedvirtual

Disable this star.

DisableIfAlreadyCollected()

virtual void MoreMountains.TopDownEngine.DeadlineStar.DisableIfAlreadyCollected ( )

protectedvirtual

Disables the star if it's already been collected in the past.

Start()

override void MoreMountains.TopDownEngine.DeadlineStar.Start ( )

protectedvirtual

On Start we disable our star if needed.

Reimplemented from MoreMountains.TopDownEngine.PickableItem.

---

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

• H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/Demos/Deadline/Scripts/DeadlineStar.cs