A platform that falls off the screen after a given number of seconds. More...

Inheritance diagram for PlatformerPro.DestroyOnStandPlatform:

Public Types
enum class	DamageMode { ALWAYS_DESTROY = 0 , ALWAYS_DAMAGE = 1 , INSTANT_CANCEL = 2 }

Public Member Functions
override void	Parent (IMob character)
	Called when the character is parented to this platform. More...

override void	UnParent (IMob character)
	Called when the character is unparented from this platform. More...

Public Member Functions inherited from PlatformerPro.ParentOnStandPlatform
override void	Parent (IMob character)
	Called when the character is parented to this platform. More...

override void	UnParent (IMob character)
	Called when the character is unparented from this platform. More...

Public Member Functions inherited from PlatformerPro.Platform
virtual void	Activate (IMob mob)
	Activate the platform. More...

virtual void	Deactivate (IMob mob)
	Deactivate the platform. More...

virtual bool	IgnoreCollision (Character character, BasicRaycast collider)
	Called to determine if collision should be ignored. Use for one way platforms or z-ordered platforms like those found in loops. More...

virtual bool	Collide (PlatformCollisionArgs args)
	Called when one of the characters colliders collides with this platform. More...

virtual bool	SkipMovement (Character character, Movement movement)
	Does this platform want to prevent the given movement from moving. Generally implementations will use the movement.GetType() to restrict specific classes of movement. Only applied when character is parented to the platform. More...

Public Member Functions inherited from PlatformerPro.PersistableObject
void	SetPersistenceState (bool state)
	Sets the persistence state. More...

void	SetPersistenceState (bool state, string extraPersistenceData)
	Sets the persistence state, overriding extra persistence data More...

Public Member Functions inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual void	Validate (PlatformerProMonoBehaviour myTarget)
	Override this method if you want to provide custom validation. The actual code should be surrounded by the if UNITY_EDITOR / endif directive. More...

Public Attributes
int	health
	How much health the platform has. More...

float	damageDelay
	The time in seconds before the platform takes damage. More...

Sprite[]	sprites
	If populated this will indicate damage by changing sprites automatically. Leave empty if you don't want to do this. The array index corresponds to the sprite. You can leave sprite at position 0 as null if you want platform to disappear. More...

DamageMode	damageCancelMode = DamageMode.INSTANT_CANCEL
	Controls what happens when the player leaves the platform. Does it reset the timer causing 0 damage, cause 1 damage, or always completely destroy platform. More...

Public Attributes inherited from PlatformerPro.ParentOnStandPlatform
bool	parentOnHeadCollission
	Should we parent when the head collides with this platform (used when you have hang from ceiling). More...

Public Attributes inherited from PlatformerPro.Platform
bool	useDefaultPersistence
	Does this Item get persistence defaults form the Game manager? More...

Public Attributes inherited from PlatformerPro.PersistableObject
bool	enablePersistence
	Should we enable persistence? More...

string	guid = System.Guid.NewGuid().ToString()
	Unique ID for this object. You shoulnd't need to edit this, use editor debug mode if you must. More...

GameObject	target
	GameObject to apply persitence settings to, defaults to self. More...

PersistableObjectType	persistenceImplementation
	How do we implement the persistence settings. More...

bool	defaultStateIsDisabled
	If true then the obejct starts disabled. More...

string	spawnedObjectName
	If this item was spawned then save the name of the prefab here. More...

Protected Member Functions
override void	PostInit ()
	Init this instance. More...

override bool	CustomCollide (PlatformCollisionArgs args)
	If the collission is a foot try to parent. More...

IEnumerator	StartDamageTimer ()
	Starts the damage timer, then once it expires applies 1 damage. More...

Protected Member Functions inherited from PlatformerPro.ParentOnStandPlatform
override void	DoUpdate ()
	Unit update hook. More...

virtual void	DoMove ()
	Do the moving. More...

override bool	CustomCollide (PlatformCollisionArgs args)
	If the collission is a foot try to parent. More...

Protected Member Functions inherited from PlatformerPro.Platform
virtual void	OnPlatformActivated (IMob character)
	Raises the activated event. More...

virtual void	OnPlatformDeactivated (IMob character)
	Raises the deactivated event. More...

virtual void	OnFired (IMob character)
	Raises the fired event. More...

override void	PostInit ()
	Init this instance. More...

void	BaseCollide (PlatformCollisionArgs args)
	Called when one of the characters colliders collides with this platform. This handles basic shared behaviour. If you want to ignore it you can ovverride Collide() instead of CustomCollide(). More...

virtual void	SavePersistenceData ()
	Gets the extra persistence data which is used to save platform state. NOTE: Generally you should override ExtraPersistenceData to save a different set of data. More...

override void	ApplyCustomPersistence (PersistableObjectData data)
	Custom persistable implementation. Override to customise. More...

virtual void	DoDrawGizmos ()
	Draw the base gizmos More...

virtual void	DoDrawSelectedGizmos ()
	Draw the base gizmos shown when selected. More...

virtual void	OnConnectedToObject (Object other)
	Called when the connect handle is dragged on to another object. More...

Protected Member Functions inherited from PlatformerPro.PersistableObject
virtual void	SetPersistenceDefaults ()
	Sets the persistence defaults. More...

virtual void	ProcessState ()
	Processes the persisted state. More...

virtual void	ApplyExtraPersistenceData (PersistableObjectData data)
	Apply any extra data. This differs from custom persistence, as custom persistence must control both data and ctivation state. More...

Protected Attributes
SpriteRenderer	myRenderer
	Cached reference to the renderer. More...

Collider2D	myCollider
	Cached reference to platform collider. More...

bool	timerHasStarted
	Have we started the count down> More...

Protected Attributes inherited from PlatformerPro.Platform
float	friction = -1
	The friction coefficient use -1 for default. More...

PlatformActivationType	automaticActivation
	How should the platform activate itself? More...

PlatformDeactivationType	automaticDeactivation
	How should the platform deactivate itself? More...

bool	conditionsEnableCollisions = true
	Should additional conditions enable or disable collisions. More...

CharacterEventArgs	characterEventArgs
	A cached character event args that we update so we don't need to allocate. More...

AdditionalCondition[]	conditions
	Cached list of all additional conditions. More...

Additional Inherited Members
Static Public Attributes inherited from PlatformerPro.Platform
static Color	GizmoColor = new Color(0.3f, 0.4f, 1.0f, 1.0f)
	Default color to use when drawing Platform gizmos. More...

Static Protected Attributes inherited from PlatformerPro.Platform
static GUIStyle	connectionHandleStyle
	The conneciton handle stlye More...

static Platform	activeConnectHandleDrag

static Vector3	currentConnectPosition

Properties inherited from PlatformerPro.Platform
virtual bool	Activated `[get, protected set]`
	Gets or sets a value indicating whether this PlatformerPro.Platform is activated. More...

virtual float	Friction `[get]`
	Gets the friction coefficent for the platform. Returns -1 if the default should be used. More...

virtual bool	IsMultiplayerReady `[get]`
	Gets a value indicating whether this platform can handle multiple characters at once. More...

virtual PlatformActivationType	ForcedActivation `[get]`
	If this is not NONE then the actiation state will be forced to this value and not editable by user. More...

virtual PlatformDeactivationType	ForcedDeactivation `[get]`
	If this is not NONE then the deactiation state will be forced to this value and not editable by user. More...

Properties inherited from PlatformerPro.PersistableObject
virtual string	ExtraPersistenceData `[get]`
	Gets the extra persistence data. More...

Properties inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual string	Header `[get]`
	Gets the header string used to describe the component. More...

virtual string	DocLink `[get]`
	Gets a link to documentation site. More...

virtual string	VideoLink `[get]`
	Gets a link to a youtube video. More...

virtual string	Deprecated `[get]`
	If non-null this component is deprecated. The string shows a message indicating how it should be replaced. More...

Events inherited from PlatformerPro.Platform
System.EventHandler< CharacterEventArgs >	PlatformActivated
	Occurs when activated. More...

System.EventHandler< CharacterEventArgs >	PlatformDeactivated
	Occurs when deactivated. More...

System.EventHandler< CharacterEventArgs >	Fired
	Some platforms have a special kind of action separate to activa or deactivate. For example the spring of a spring baord, or the fall of a decaying platform. This event is sent for those states. More...

Detailed Description

A platform that falls off the screen after a given number of seconds.

Member Enumeration Documentation

◆ DamageMode

enum PlatformerPro.DestroyOnStandPlatform.DamageMode

strong

Enumerator
ALWAYS_DESTROY
ALWAYS_DAMAGE
INSTANT_CANCEL

Member Function Documentation

◆ CustomCollide()

override bool PlatformerPro.DestroyOnStandPlatform.CustomCollide ( PlatformCollisionArgs args )

protectedvirtual

If the collission is a foot try to parent.

Parameters

character	Character.
type	Type of raycast.

Returns: true if character should be parented to this platform, otherwise false.

Reimplemented from PlatformerPro.Platform.

◆ Parent()

override void PlatformerPro.DestroyOnStandPlatform.Parent ( IMob character )

virtual

Called when the character is parented to this platform.

Reimplemented from PlatformerPro.Platform.

◆ PostInit()

override void PlatformerPro.DestroyOnStandPlatform.PostInit ( )

protectedvirtual

Init this instance.

Reimplemented from PlatformerPro.PersistableObject.

◆ StartDamageTimer()

IEnumerator PlatformerPro.DestroyOnStandPlatform.StartDamageTimer ( )

protected

Starts the damage timer, then once it expires applies 1 damage.

Returns: The fall timer.

◆ UnParent()

override void PlatformerPro.DestroyOnStandPlatform.UnParent ( IMob character )

virtual

Called when the character is unparented from this platform.

Parameters

character Character being unparented.

Reimplemented from PlatformerPro.Platform.

Member Data Documentation

◆ damageCancelMode

DamageMode PlatformerPro.DestroyOnStandPlatform.damageCancelMode = DamageMode.INSTANT_CANCEL

Controls what happens when the player leaves the platform. Does it reset the timer causing 0 damage, cause 1 damage, or always completely destroy platform.

◆ damageDelay

float PlatformerPro.DestroyOnStandPlatform.damageDelay

The time in seconds before the platform takes damage.

◆ health

int PlatformerPro.DestroyOnStandPlatform.health

How much health the platform has.

◆ myCollider

Collider2D PlatformerPro.DestroyOnStandPlatform.myCollider

protected

Cached reference to platform collider.

◆ myRenderer

SpriteRenderer PlatformerPro.DestroyOnStandPlatform.myRenderer

protected

Cached reference to the renderer.

◆ sprites

Sprite [] PlatformerPro.DestroyOnStandPlatform.sprites

If populated this will indicate damage by changing sprites automatically. Leave empty if you don't want to do this. The array index corresponds to the sprite. You can leave sprite at position 0 as null if you want platform to disappear.

◆ timerHasStarted

bool PlatformerPro.DestroyOnStandPlatform.timerHasStarted

protected

Have we started the count down>

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

D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/Platforms/DestroyOnStandPlatform.cs

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ DamageMode

Member Function Documentation

◆ CustomCollide()

◆ Parent()

◆ PostInit()

◆ StartDamageTimer()

◆ UnParent()

Member Data Documentation

◆ damageCancelMode

◆ damageDelay

◆ health

◆ myCollider

◆ myRenderer

◆ sprites

◆ timerHasStarted