DamageOnTrigger Class Reference

Detailed Description

Put this script on objects you want to damage entities upon touching with them. The difference between this and DamageOnCollision is this is for objects whose Collider2D has isTrigger checked off in the editor. Useful for stage hazards, such as the spikes tile.

Documentation updated 8/26/2024

Author

Stephen Nuttall

Note

There is a similar script called DamageOnCollision that does the same thing for objects whose Collider2D has isTrigger NOT checked off in the editor. This requires a different function to be used, which is why there's a separate script for it.

Todo

Replace damageNonPlayers and damagePlayer bools with one layer mask that allows for more choices in what is damaged.

Public Attributes
int	colisionDamage = 40
	Amount of damage to apply when upon colliding with an object (that can be damaged).
bool	damageNonPlayers = true
	If true, entities that are not the player will take damage when colliding with this object.
bool	damagePlayer = true
	If true, the player will take damage when colliding with this object.

Private Member Functions
void	OnTriggerEnter2D (Collider2D col)
	When an object collides with this object, damage it if it has an object health (unless damageNonPlayers or damagePlayer dictates otherwise). Then destroy the game object (if destroyOnCollision is true).

Member Function Documentation

OnTriggerEnter2D()

void DamageOnTrigger.OnTriggerEnter2D ( Collider2D col )

private

When an object collides with this object, damage it if it has an object health (unless damageNonPlayers or damagePlayer dictates otherwise). Then destroy the game object (if destroyOnCollision is true).

Parameters

col	Represents the object that collided with this object.

Member Data Documentation

colisionDamage

int DamageOnTrigger.colisionDamage = 40

Amount of damage to apply when upon colliding with an object (that can be damaged).

damageNonPlayers

bool DamageOnTrigger.damageNonPlayers = true

If true, entities that are not the player will take damage when colliding with this object.

damagePlayer

bool DamageOnTrigger.damagePlayer = true

If true, the player will take damage when colliding with this object.

---

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

• Assets/Scripts/Hazards/DamageOnTrigger.cs