UnityPlatformer.Item Class Reference

Abstract class to create a Usable Item More...

Inheritance diagram for UnityPlatformer.Item:

Public Member Functions
virtual void	Start ()
	Get BoxCollider2D More...
virtual Vector3	GetCenter ()
	Get real-world-coordinates center More...
virtual void	PositionCharacter (Character p)
	Set the position/facing of the player to the desired values More...
virtual void	Enter (Character p)
	notify Character is in area item More...
virtual void	Exit (Character p)
	notify Character is out area item More...
virtual bool	IsUsableBy (Character p)
	everybody can use this item otherwise, override More...
abstract void	Use (Character p)
	Implement this function with the action that need to performed More...
virtual void	OnTriggerEnter2D (Collider2D o)
	When HitBox(EnterAreas) enter -> Enter More...
virtual void	OnTriggerExit2D (Collider2D o)
	When HitBox(EnterAreas) leave -> Exit More...

Public Attributes
Vector3	offset
	Character offset when playing animation More...
Facing	facing = Facing.None
	Character facing when playing animation More...
string	animationName
	animation name to play when using More...

Detailed Description

Abstract class to create a Usable Item

Member Function Documentation

Enter()

virtual void UnityPlatformer.Item.Enter ( Character  p )

inlinevirtual

notify Character is in area item

Exit()

virtual void UnityPlatformer.Item.Exit ( Character  p )

inlinevirtual

notify Character is out area item

GetCenter()

virtual Vector3 UnityPlatformer.Item.GetCenter ( )

inlinevirtual

Get real-world-coordinates center

IsUsableBy()

virtual bool UnityPlatformer.Item.IsUsableBy ( Character  p )

inlinevirtual

everybody can use this item otherwise, override

Reimplemented in UnityPlatformer.ItemMovingPlatformController.

OnTriggerEnter2D()

virtual void UnityPlatformer.Item.OnTriggerEnter2D ( Collider2D  o )

inlinevirtual

When HitBox(EnterAreas) enter -> Enter

OnTriggerExit2D()

virtual void UnityPlatformer.Item.OnTriggerExit2D ( Collider2D  o )

inlinevirtual

When HitBox(EnterAreas) leave -> Exit

PositionCharacter()

virtual void UnityPlatformer.Item.PositionCharacter ( Character  p )

inlinevirtual

Set the position/facing of the player to the desired values

Start()

virtual void UnityPlatformer.Item.Start ( )

inlinevirtual

Get BoxCollider2D

Use()

abstract void UnityPlatformer.Item.Use ( Character  p )

pure virtual

Implement this function with the action that need to performed

Implemented in UnityPlatformer.ItemMovingPlatformController.

Member Data Documentation

animationName

string UnityPlatformer.Item.animationName

animation name to play when using

facing

Facing UnityPlatformer.Item.facing = Facing.None

Character facing when playing animation

offset

Vector3 UnityPlatformer.Item.offset

Character offset when playing animation

---

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

• Assets/UnityPlatformer/Scripts/Tiles/Item.cs