UnityPlatformer Configuration behaviour. More...

Inheritance diagram for UnityPlatformer.Configuration:

Static Public Member Functions
static bool	IsOneWayPlatformUp (GameObject obj)
	check if given GameObject has a the tag oneWayPlatformUpTag More...

static bool	IsOneWayPlatformUp (Collider2D obj)
	check if given Collider2D has a the tag oneWayPlatformUpTag More...

static bool	IsOneWayPlatformDown (GameObject obj)
	check if given GameObject has a the tag oneWayPlatformDownTag More...

static bool	IsOneWayPlatformDown (Collider2D obj)
	check if given Collider2D has a the tag oneWayPlatformDownTag More...

static bool	IsOneWayWallLeft (GameObject obj)
	check if given GameObject has a the tag oneWayWallLeftTag More...

static bool	IsOneWayWallLeft (Collider2D obj)
	check if given Collider2D has a the tag oneWayWallLeftTag More...

static bool	IsOneWayWallRight (GameObject obj)
	check if given GameObject has a the tag onwWayWallRightTag More...

static bool	IsOneWayWallRight (Collider2D obj)
	check if given Collider2D has a the tag onwWayWallRightTag More...

static bool	IsMovingPlatformThrough (GameObject obj)
	check if given GameObject has a the tag movingPlatformThroughTag More...

static bool	IsMovingPlatformThrough (Collider2D obj)
	check if given Collider2D has a the tag movingPlatformThroughTag More...

static bool	IsMovingPlatform (GameObject obj)
	check if given GameObject has a the tag movingPlatformTag More...

static bool	IsMovingPlatform (Collider2D obj)
	check if given Collider2D has a the tag movingPlatformTag More...

static bool	IsBox (GameObject obj)
	check if given GameObject has a the tag boxTag More...

static bool	IsBox (Collider2D obj)
	check if given Collider2D has a the tag boxTag More...

static Character	GetNearestPlayer (Vector3 position)
	Get nearest player to given position More...

Static Public Member Functions inherited from UnityPlatformer.MBSingleton< Configuration >
static void	ClearInstance ()
	This method is for testing purposes only, you should not called it in your application More...

Public Attributes
Vector2	gravity = Vector2.zero
	Global gravity. Can be overriden by Character.gravity More...

float	minDistanceToEnv = 0.1f
	Global min distance to Environment More...

string	playerTag = "Player"
	Player tag More...

string	oneWayPlatformUpTag = "OneWayPlatformUp"
	one-way-platform up tag More...

string	oneWayPlatformDownTag = "OneWayPlatformDown"
	one-way-platform down tag More...

string	oneWayWallLeftTag = "OneWayWallLeft"
	one-way-platform left tag More...

string	onwWayWallRightTag = "OneWayWallRight"
	one-way-platform right tag More...

string	movingPlatformThroughTag = "MovingPlatformThrough"
	moving platform through tag More...

string	movingPlatformTag = "MovingPlatform"
	moving platform tag More...

string	enemyTag = "Enemy"
	enemy tag More...

string	projectileTag = "Projectile"
	projectile tag More...

string	boxTag = "Box"
	box tag More...

int	cooldownsPriority = 100
	Cooldown priority, should be the highest so when updating anything else cooldowns are updated first More...

int	movingPlatformsPriority = 50
	Moving platform priority More...

int	charactersPriority = 30
	Characters priority More...

int	enemiesPriority = 30
	Enemies priority More...

int	projectilesPriority = 20
	Projectile priority More...

int	defaultPriority = 10
	Default priority More...

string	staticGeometryLayerName = "StaticGeometry"
	Mask name for static geometry More...

LayerMask	staticGeometryMask
	Mask for static geometry More...

string	laddersLayerName = "Ladders"
	Mask name for Ladders More...

LayerMask	laddersMask
	Mask for Ladders More...

string	fencesLayerName = "Fences"
	Mask name for Fences More...

LayerMask	fencesMask
	Mask for Fences More...

string	ropesLayerName = "Ropes"
	Mask name for Ropes More...

LayerMask	ropesMask
	Mask for Ropes More...

string	hitBoxesLayerName = "HitBoxes"
	Mask name for HitBoxes More...

LayerMask	hitBoxesMask
	Mask for HitBoxes More...

string	playersLayerName = "Players"
	Mask name for Players More...

LayerMask	playersMask
	Mask for Players More...

string	enemiesLayerName = "Enemies"
	Mask name for Enemies More...

LayerMask	enemiesMask
	Mask for Enemies More...

string	grabablesLayerName = "Grabables"
	Mask name for Grabables More...

LayerMask	grabablesMask
	Mask for Grabables More...

string	liquidsLayerName = "Liquids"
	Mask name for Liquids More...

LayerMask	liquidsMask
	Mask for Liquids More...

string	boxesLayerName = "Boxes"
	Mask name for Boxes More...

LayerMask	boxesMask
	Mask for Boxes More...

string	tracksLayerName = "Tracks"
	Mask name for Tracks More...

LayerMask	tracksMask
	Mask for Tracks More...

string	itemsLayerName = "Items"
	Mask name for Items More...

LayerMask	itemsMask
	Mask for Items More...

string	projectilesLayerName = "Projectiles"
	Mask name for Items More...

LayerMask	projectilesMask
	Mask for Items More...

LayerMask	recieveDamageMask
	Mask for HitBoxes with type RecieveDamage More...

LayerMask	dealDamageMask
	Mask for HitBoxes with type DealDamage More...

LayerMask	enterAreasMask
	Mask for HitBoxes with type EnterAreas More...

Additional Inherited Members
Static Protected Attributes inherited from UnityPlatformer.MBSingleton< Configuration >
static T	_instance
	Singleton instance More...

Properties inherited from UnityPlatformer.MBSingleton< Configuration >
static T	instance `[get]`
	Singleton instance retrieval More...

Detailed Description

UnityPlatformer Configuration behaviour.

It's a singleton and must be included in every scene.
We recommended you to prefab this.
NOTE executionOrder should be -100

Member Function Documentation

◆ GetNearestPlayer()

static Character UnityPlatformer.Configuration.GetNearestPlayer ( Vector3 position )

inlinestatic

Get nearest player to given position

◆ IsBox() [1/2]

static bool UnityPlatformer.Configuration.IsBox ( GameObject obj )

inlinestatic

check if given GameObject has a the tag boxTag

◆ IsBox() [2/2]

static bool UnityPlatformer.Configuration.IsBox ( Collider2D obj )

inlinestatic

check if given Collider2D has a the tag boxTag

◆ IsMovingPlatform() [1/2]

static bool UnityPlatformer.Configuration.IsMovingPlatform ( GameObject obj )

inlinestatic

check if given GameObject has a the tag movingPlatformTag

◆ IsMovingPlatform() [2/2]

static bool UnityPlatformer.Configuration.IsMovingPlatform ( Collider2D obj )

inlinestatic

check if given Collider2D has a the tag movingPlatformTag

◆ IsMovingPlatformThrough() [1/2]

static bool UnityPlatformer.Configuration.IsMovingPlatformThrough ( GameObject obj )

inlinestatic

check if given GameObject has a the tag movingPlatformThroughTag

◆ IsMovingPlatformThrough() [2/2]

static bool UnityPlatformer.Configuration.IsMovingPlatformThrough ( Collider2D obj )

inlinestatic

check if given Collider2D has a the tag movingPlatformThroughTag

◆ IsOneWayPlatformDown() [1/2]

static bool UnityPlatformer.Configuration.IsOneWayPlatformDown ( GameObject obj )

inlinestatic

check if given GameObject has a the tag oneWayPlatformDownTag

◆ IsOneWayPlatformDown() [2/2]

static bool UnityPlatformer.Configuration.IsOneWayPlatformDown ( Collider2D obj )

inlinestatic

check if given Collider2D has a the tag oneWayPlatformDownTag

◆ IsOneWayPlatformUp() [1/2]

static bool UnityPlatformer.Configuration.IsOneWayPlatformUp ( GameObject obj )

inlinestatic

check if given GameObject has a the tag oneWayPlatformUpTag

◆ IsOneWayPlatformUp() [2/2]

static bool UnityPlatformer.Configuration.IsOneWayPlatformUp ( Collider2D obj )

inlinestatic

check if given Collider2D has a the tag oneWayPlatformUpTag

◆ IsOneWayWallLeft() [1/2]

static bool UnityPlatformer.Configuration.IsOneWayWallLeft ( GameObject obj )

inlinestatic

check if given GameObject has a the tag oneWayWallLeftTag

◆ IsOneWayWallLeft() [2/2]

static bool UnityPlatformer.Configuration.IsOneWayWallLeft ( Collider2D obj )

inlinestatic

check if given Collider2D has a the tag oneWayWallLeftTag

◆ IsOneWayWallRight() [1/2]

static bool UnityPlatformer.Configuration.IsOneWayWallRight ( GameObject obj )

inlinestatic

check if given GameObject has a the tag onwWayWallRightTag

◆ IsOneWayWallRight() [2/2]

static bool UnityPlatformer.Configuration.IsOneWayWallRight ( Collider2D obj )

inlinestatic

check if given Collider2D has a the tag onwWayWallRightTag

Member Data Documentation

◆ boxesLayerName

string UnityPlatformer.Configuration.boxesLayerName = "Boxes"

Mask name for Boxes

◆ boxesMask

LayerMask UnityPlatformer.Configuration.boxesMask

Mask for Boxes

◆ boxTag

string UnityPlatformer.Configuration.boxTag = "Box"

box tag

◆ charactersPriority

int UnityPlatformer.Configuration.charactersPriority = 30

Characters priority

◆ cooldownsPriority

int UnityPlatformer.Configuration.cooldownsPriority = 100

Cooldown priority, should be the highest so when updating anything else cooldowns are updated first

◆ dealDamageMask

LayerMask UnityPlatformer.Configuration.dealDamageMask

Mask for HitBoxes with type DealDamage

◆ defaultPriority

int UnityPlatformer.Configuration.defaultPriority = 10

Default priority

◆ enemiesLayerName

string UnityPlatformer.Configuration.enemiesLayerName = "Enemies"

Mask name for Enemies

◆ enemiesMask

LayerMask UnityPlatformer.Configuration.enemiesMask

Mask for Enemies

◆ enemiesPriority

int UnityPlatformer.Configuration.enemiesPriority = 30

Enemies priority

◆ enemyTag

string UnityPlatformer.Configuration.enemyTag = "Enemy"

enemy tag

◆ enterAreasMask

LayerMask UnityPlatformer.Configuration.enterAreasMask

Mask for HitBoxes with type EnterAreas

◆ fencesLayerName

string UnityPlatformer.Configuration.fencesLayerName = "Fences"

Mask name for Fences

◆ fencesMask

LayerMask UnityPlatformer.Configuration.fencesMask

Mask for Fences

◆ grabablesLayerName

string UnityPlatformer.Configuration.grabablesLayerName = "Grabables"

Mask name for Grabables

◆ grabablesMask

LayerMask UnityPlatformer.Configuration.grabablesMask

Mask for Grabables

◆ gravity

Vector2 UnityPlatformer.Configuration.gravity = Vector2.zero

Global gravity. Can be overriden by Character.gravity

◆ hitBoxesLayerName

string UnityPlatformer.Configuration.hitBoxesLayerName = "HitBoxes"

Mask name for HitBoxes

◆ hitBoxesMask

LayerMask UnityPlatformer.Configuration.hitBoxesMask

Mask for HitBoxes

◆ itemsLayerName

string UnityPlatformer.Configuration.itemsLayerName = "Items"

Mask name for Items

◆ itemsMask

LayerMask UnityPlatformer.Configuration.itemsMask

Mask for Items

◆ laddersLayerName

string UnityPlatformer.Configuration.laddersLayerName = "Ladders"

Mask name for Ladders

◆ laddersMask

LayerMask UnityPlatformer.Configuration.laddersMask

Mask for Ladders

◆ liquidsLayerName

string UnityPlatformer.Configuration.liquidsLayerName = "Liquids"

Mask name for Liquids

◆ liquidsMask

LayerMask UnityPlatformer.Configuration.liquidsMask

Mask for Liquids

◆ minDistanceToEnv

float UnityPlatformer.Configuration.minDistanceToEnv = 0.1f

Global min distance to Environment

◆ movingPlatformsPriority

int UnityPlatformer.Configuration.movingPlatformsPriority = 50

Moving platform priority

◆ movingPlatformTag

string UnityPlatformer.Configuration.movingPlatformTag = "MovingPlatform"

moving platform tag

◆ movingPlatformThroughTag

string UnityPlatformer.Configuration.movingPlatformThroughTag = "MovingPlatformThrough"

moving platform through tag

◆ oneWayPlatformDownTag

string UnityPlatformer.Configuration.oneWayPlatformDownTag = "OneWayPlatformDown"

one-way-platform down tag

◆ oneWayPlatformUpTag

string UnityPlatformer.Configuration.oneWayPlatformUpTag = "OneWayPlatformUp"

one-way-platform up tag

◆ oneWayWallLeftTag

string UnityPlatformer.Configuration.oneWayWallLeftTag = "OneWayWallLeft"

one-way-platform left tag

◆ onwWayWallRightTag

string UnityPlatformer.Configuration.onwWayWallRightTag = "OneWayWallRight"

one-way-platform right tag

◆ playersLayerName

string UnityPlatformer.Configuration.playersLayerName = "Players"

Mask name for Players

◆ playersMask

LayerMask UnityPlatformer.Configuration.playersMask

Mask for Players

◆ playerTag

string UnityPlatformer.Configuration.playerTag = "Player"

Player tag

◆ projectilesLayerName

string UnityPlatformer.Configuration.projectilesLayerName = "Projectiles"

Mask name for Items

◆ projectilesMask

LayerMask UnityPlatformer.Configuration.projectilesMask

Mask for Items

◆ projectilesPriority

int UnityPlatformer.Configuration.projectilesPriority = 20

Projectile priority

◆ projectileTag

string UnityPlatformer.Configuration.projectileTag = "Projectile"

projectile tag

◆ recieveDamageMask

LayerMask UnityPlatformer.Configuration.recieveDamageMask

Mask for HitBoxes with type RecieveDamage

◆ ropesLayerName

string UnityPlatformer.Configuration.ropesLayerName = "Ropes"

Mask name for Ropes

◆ ropesMask

LayerMask UnityPlatformer.Configuration.ropesMask

Mask for Ropes

◆ staticGeometryLayerName

string UnityPlatformer.Configuration.staticGeometryLayerName = "StaticGeometry"

Mask name for static geometry

◆ staticGeometryMask

LayerMask UnityPlatformer.Configuration.staticGeometryMask

Mask for static geometry

◆ tracksLayerName

string UnityPlatformer.Configuration.tracksLayerName = "Tracks"

Mask name for Tracks

◆ tracksMask

LayerMask UnityPlatformer.Configuration.tracksMask

Mask for Tracks

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

Assets/UnityPlatformer/Scripts/Configuration.cs

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetNearestPlayer()

◆ IsBox() [1/2]

◆ IsBox() [2/2]

◆ IsMovingPlatform() [1/2]

◆ IsMovingPlatform() [2/2]

◆ IsMovingPlatformThrough() [1/2]

◆ IsMovingPlatformThrough() [2/2]

◆ IsOneWayPlatformDown() [1/2]

◆ IsOneWayPlatformDown() [2/2]

◆ IsOneWayPlatformUp() [1/2]

◆ IsOneWayPlatformUp() [2/2]

◆ IsOneWayWallLeft() [1/2]

◆ IsOneWayWallLeft() [2/2]

◆ IsOneWayWallRight() [1/2]

◆ IsOneWayWallRight() [2/2]

Member Data Documentation

◆ boxesLayerName

◆ boxesMask

◆ boxTag

◆ charactersPriority

◆ cooldownsPriority

◆ dealDamageMask

◆ defaultPriority

◆ enemiesLayerName

◆ enemiesMask

◆ enemiesPriority

◆ enemyTag

◆ enterAreasMask

◆ fencesLayerName

◆ fencesMask

◆ grabablesLayerName

◆ grabablesMask

◆ gravity

◆ hitBoxesLayerName

◆ hitBoxesMask

◆ itemsLayerName

◆ itemsMask

◆ laddersLayerName

◆ laddersMask

◆ liquidsLayerName

◆ liquidsMask

◆ minDistanceToEnv

◆ movingPlatformsPriority

◆ movingPlatformTag

◆ movingPlatformThroughTag

◆ oneWayPlatformDownTag

◆ oneWayPlatformUpTag

◆ oneWayWallLeftTag

◆ onwWayWallRightTag

◆ playersLayerName

◆ playersMask

◆ playerTag

◆ projectilesLayerName

◆ projectilesMask

◆ projectilesPriority

◆ projectileTag

◆ recieveDamageMask

◆ ropesLayerName

◆ ropesMask

◆ staticGeometryLayerName

◆ staticGeometryMask

◆ tracksLayerName

◆ tracksMask