Add this script to a trigger collider2D to teleport objects from that object to its destination More...

Inheritance diagram for MoreMountains.CorgiEngine.Teleporter:

Public Types
enum	CameraModes { CameraModes.DoNothing, CameraModes.TeleportCamera, CameraModes.CinemachinePriority }
	the possible modes the teleporter can interact with the camera system on activation, either doing nothing, teleporting the camera to a new position, or blending between Cinemachine virtual cameras More...

enum	TeleportationModes { TeleportationModes.Instant, TeleportationModes.Tween }
	the possible teleportation modes (either 1-frame instant teleportation, or tween between this teleporter and its destination) More...

Public Types inherited from MoreMountains.CorgiEngine.ButtonActivated
enum	ButtonActivatedRequirements { ButtonActivatedRequirements.Character, ButtonActivatedRequirements.ButtonActivator, ButtonActivatedRequirements.Either, ButtonActivatedRequirements.None }
	the different possible requirements for this activated zone, which can be either a character, a button activator, one or the other, or none More...

enum	InputTypes { InputTypes.Default, InputTypes.Button, InputTypes.Key }
	how input gets detected for this zone (default : default binding from the InputManager for Interact, button (type in an axis button name), or key) More...

Public Member Functions
override void	TriggerButtonAction (GameObject instigator)
	If we're button activated and if the button is pressed, we teleport More...

override void	TriggerExitAction (GameObject collider)
	When something exits the teleporter, if it's on the ignore list, we remove it from it, so it'll be considered next time it enters. More...

virtual void	AddToIgnoreList (Transform objectToIgnore)
	Adds an object to the ignore list, which will prevent that object to be moved by the teleporter while it's in that list More...

Public Member Functions inherited from MoreMountains.CorgiEngine.ButtonActivated
virtual void	Initialization ()
	Grabs components and shows prompt if needed More...

virtual void	MakeActivable ()
	Makes the zone activable More...

virtual void	MakeUnactivable ()
	Makes the zone unactivable More...

virtual void	ToggleActivable ()
	Makes the zone activable if it wasn't, unactivable if it was activable. More...

virtual void	PromptError ()
	Triggers an error More...

virtual void	ShowPrompt ()
	Shows the button A prompt. More...

virtual void	HidePrompt ()
	Hides the button A prompt. More...

virtual void	DisableZone ()
	Enables the button activated zone More...

virtual void	EnableZone ()
	Enables the button activated zone More...

virtual bool	CheckNumberOfUses ()
	Checks the remaining number of uses and eventual delay between uses and returns true if the zone can be activated. More...

Public Attributes
bool	OnlyAffectsPlayer = true
	if true, this won't teleport non player characters More...

Vector3	ExitOffset
	the offset to apply when exiting this teleporter More...

TeleportationModes	TeleportationMode = TeleportationModes.Instant
	the selected teleportation mode More...

MMTween.MMTweenCurve	TweenCurve = MMTween.MMTweenCurve.EaseInCubic
	the curve to apply to the teleportation tween More...

bool	MaintainXEntryPositionOnExit = false
	whether or not to maintain the x value of the teleported object on exit More...

bool	MaintainYEntryPositionOnExit = false
	whether or not to maintain the y value of the teleported object on exit More...

Teleporter	Destination
	the teleporter's destination More...

bool	AddToDestinationIgnoreList = true

CameraModes	CameraMode = CameraModes.TeleportCamera
	the chosen camera mode More...

Room	CurrentRoom
	the room this teleporter belongs to More...

Room	TargetRoom
	the target room More...

bool	TriggerFade = false
	if this is true, a fade to black will occur when teleporting More...

int	FaderID = 0
	the ID of the fader to target More...

MMTweenType	FadeTween = new MMTweenType(MMTween.MMTweenCurve.EaseInCubic)
	the curve to use to fade to black More...

bool	MoveMask = true
	whether or not we should ask to move a MMSpriteMask on activation More...

MMTween.MMTweenCurve	MoveMaskCurve = MMTween.MMTweenCurve.EaseInCubic
	the curve to move the mask along to More...

MMSpriteMaskEvent.MMSpriteMaskEventTypes	MoveMaskMethod = MMSpriteMaskEvent.MMSpriteMaskEventTypes.ExpandAndMoveToNewPosition
	the method to move the mask More...

float	MoveMaskDuration = 0.2f
	the duration of the mask movement (usually the same as the DelayBetweenFades More...

bool	FreezeTime = false
	whether or not time should be frozen during the transition More...

bool	FreezeCharacter = true
	whether or not the character should be frozen (input blocked) for the duration of the transition More...

bool	ResetMovementStateOnTeleport = false
	whether or not to reset movement state on the character as it teleports More...

TimescaleModes	TimescaleMode = TimescaleModes.Scaled
	whether to operate the teleport sequence on scaled or unscaled time More...

float	InitialDelay = 0.1f
	the delay (in seconds) to apply before running the sequence More...

float	FadeOutDuration = 0.2f
	the duration (in seconds) after the initial delay covering for the fade out of the scene More...

float	DelayBetweenFades = 0.3f
	the duration (in seconds) to wait for after the fade out and before the fade in More...

float	FadeInDuration = 0.2f
	the duration (in seconds) after the initial delay covering for the fade in of the scene More...

float	FinalDelay = 0.1f
	the duration (in seconds) to apply after the fade in of the scene More...

MMFeedbacks	SequenceStartFeedback
	a feedback that will get played when the initial delay starts More...

MMFeedbacks	AfterInitialDelayFeedback
	a feedback that will get played at the start of the fade out duration More...

MMFeedbacks	AfterFadeOutFeedback
	a feedback that will get played at the start of the delay between fades More...

MMFeedbacks	AfterDelayBetweenFadesFeedback
	a feedback that will get played at the start of the fade in More...

MMFeedbacks	SequenceEndFeedback
	a feedback that will get played at the start of the final delay More...

MMFeedbacks	ArrivedHereFeedback
	a feedback that gets played on this teleporter when another teleporter sends a character here More...

Public Attributes inherited from MoreMountains.CorgiEngine.ButtonActivated
ButtonActivatedRequirements	ButtonActivatedRequirement = ButtonActivatedRequirements.Either
	the requirement(s) for this zone More...

bool	RequiresPlayerType = true
	if this is true, this can only be activated by player Characters More...

bool	RequiresButtonActivationAbility = true
	if this is true, this zone can only be activated if the character has the required ability More...

bool	PreventJumpsWhileInThisZone = false
	if this is true, characters won't be able to jump when in that zone, regardless of the settings on their CharacterButtonActivation ability More...

bool	Activable = true
	if this is false, the zone won't be activable More...

bool	AutoActivation = false
	if true, the zone will activate whether the button is pressed or not More...

bool	AutoActivationAndButtonInteraction = false
	if true, this zone will be auto activated but will still allow button interaction More...

bool	CanOnlyActivateIfGrounded = false
	if this is set to false, the zone won't be activable while not grounded More...

bool	ShouldUpdateState = true
	Set this to true if you want the CharacterBehaviorState to be notified of the player's entry into the zone. More...

bool	OnlyOneActivationAtOnce = true
	if this is true, enter won't be retriggered if another object enters, and exit will only be triggered when the last object exits More...

bool	AlsoPerformChecksOnStay = false
	if this is true, extra enter checks will be performed on TriggerStay, to handle edge cases like a zone that'd prevent activation when not grounded, and a character enters it airborne, but then lands More...

LayerMask	TargetLayerMask = ~0
	a layermask with all the layers that can interact with this specific button activated zone More...

bool	UnlimitedActivations = true
	if this is set to false, your number of activations will be MaxNumberOfActivations More...

int	MaxNumberOfActivations = 0
	the number of times the zone can be interacted with More...

float	DelayBetweenUses = 0f
	the delay (in seconds) after an activation during which the zone can't be activated More...

bool	DisableAfterUse = false
	if this is true, the zone will disable itself (forever or until you manually reactivate it) after its last use More...

InputTypes	InputType = InputTypes.Default
	the selected input type (default : default binding from the InputManager for Interact, button (type in an axis button name), or key) More...

string	InputButton = "Interact"
	the button axis name to use for this button activated object More...

KeyCode	InputKey = KeyCode.Space
	the key to use for this More...

string	AnimationTriggerParameterName
	an (absolutely optional) animation parameter that can be triggered on the character when activating the zone More...

bool	UseVisualPrompt = true
	if this is true, a prompt will be shown if setup properly More...

ButtonPrompt	ButtonPromptPrefab
	the gameobject to instantiate to present the prompt More...

string	ButtonPromptText = "A"
	the text to display in the button prompt More...

Color	ButtonPromptColor = MMColors.LawnGreen
	the text to display in the button prompt More...

Color	ButtonPromptTextColor = MMColors.White
	the color for the prompt's text More...

bool	AlwaysShowPrompt = true
	If true, the "buttonA" prompt will always be shown, whether the player is in the zone or not. More...

bool	ShowPromptWhenColliding = true
	If true, the "buttonA" prompt will be shown when a player is colliding with the zone. More...

bool	HidePromptAfterUse = false
	If true, the prompt will hide after use. More...

Vector3	PromptRelativePosition = Vector3.zero
	the position of the actual buttonA prompt relative to the object's center More...

MMFeedbacks	ActivationFeedback
	a feedback to play when the zone gets activated More...

MMFeedbacks	DeniedFeedback
	a feedback to play when the zone tries to get activated but can't More...

MMFeedbacks	EnterFeedback
	a feedback to play when the zone gets entered More...

MMFeedbacks	ExitFeedback
	a feedback to play when the zone gets exited More...

UnityEvent	OnActivation
	an action to trigger when this gets activated More...

UnityEvent	OnExit
	an action to trigger when exiting this zone More...

UnityEvent	OnStay
	an action to trigger when staying in the zone More...

Protected Member Functions
virtual void	Awake ()
	On start we initialize our ignore list More...

virtual void	InitializeTeleporter ()
	Grabs the current room in the parent if needed More...

override void	OnTriggerEnter2D (Collider2D collider)
	Triggered when something enters the teleporter More...

override void	OnTriggerStay2D (Collider2D collider)
	On stay we invoke our stay event if needed, and perform a trigger enter check if it hasn't been done already More...

virtual void	Teleport (Collider2D collider)
	Teleports whatever enters the portal to a new destination More...

virtual IEnumerator	TeleportSequence (Collider2D collider)
	Handles the teleport sequence (fade in, pause, fade out) More...

virtual void	SequenceStart (Collider2D collider)
	Describes the events happening before the initial fade in More...

virtual void	AfterInitialDelay (Collider2D collider)
	Describes the events happening after the initial delay has passed More...

virtual void	AfterFadeOut (Collider2D collider)
	Describes the events happening once the initial fade in is complete More...

virtual void	TeleportCollider (Collider2D collider)
	Teleports the object going through the teleporter, either instantly or by tween More...

virtual IEnumerator	TeleportTweenCo (Collider2D collider, Vector3 origin, Vector3 destination)
	Tweens the object from origin to destination More...

virtual void	BetweenFades (Collider2D collider)
	Describes what happens midway through the fade More...

virtual void	AfterDelayBetweenFades (Collider2D collider)
	Describes the events happening after the pause between the fade in and the fade out More...

virtual void	AfterFadeIn (Collider2D collider)
	Describes the events happening after the fade in of the scene More...

virtual void	SequenceEnd (Collider2D collider)
	Describes the events happening after the fade out is complete, so at the end of the teleport sequence More...

virtual void	OnDrawGizmos ()
	On draw gizmos, we draw arrows to the target destination and target room if there are any More...

Protected Member Functions inherited from MoreMountains.CorgiEngine.ButtonActivated
virtual void	OnEnable ()
	On Enable, we initialize our ButtonActivated zone More...

virtual void	OnDisable ()
	On disable we disable our input action if needed More...

virtual void	ActivateZone ()
	Activates the zone More...

virtual void	DisableAfterActivation ()
	Handles the disabling of the zone after activation More...

virtual void	OnTriggerExit2D (Collider2D collidingObject)
	Handles enter collision with 2D triggers More...

virtual void	TriggerEnter (GameObject collider)
	Triggered when something collides with the button activated zone More...

virtual void	TriggerExit (GameObject collider)
	Triggered when something exits the water More...

virtual bool	TestForLastObject (GameObject collider)
	Tests if the object exiting our zone is the last remaining one More...

virtual bool	CheckConditions (GameObject collider)
	Determines whether or not this zone should be activated More...

Protected Attributes
List< Transform >	_ignoreList

WaitForSecondsRealtime	_initialDelayWaitForSeconds

WaitForSecondsRealtime	_fadeOutDurationWaitForSeconds

WaitForSecondsRealtime	_halfDelayBetweenFadesWaitForSeconds

WaitForSecondsRealtime	_fadeInDurationWaitForSeconds

WaitForSecondsRealtime	_finalDelayyWaitForSeconds

WaitForSeconds	_initialDelayWaitForSecondsScaled

WaitForSeconds	_fadeOutDurationWaitForSecondsScaled

WaitForSeconds	_halfDelayBetweenFadesWaitForSecondsScaled

WaitForSeconds	_fadeInDurationWaitForSecondsScaled

WaitForSeconds	_finalDelayyWaitForSecondsScaled

Vector3	_entryPosition

Vector3	_newPosition

Protected Attributes inherited from MoreMountains.CorgiEngine.ButtonActivated
Animator	_buttonPromptAnimator

ButtonPrompt	_buttonPrompt

bool	_promptHiddenForever = false

int	_numberOfActivationsLeft

float	_lastActivationTimestamp

Collider2D	_buttonActivatedZoneCollider

CharacterButtonActivation	_characterButtonActivation

Character	_currentCharacter

List< GameObject >	_collidingObjects

List< GameObject >	_stayingGameObjects

List< Collider2D >	_enteredColliders

int	_inputActionPressedAtFrame

Additional Inherited Members
Properties inherited from MoreMountains.CorgiEngine.ButtonActivated
bool	InputActionPerformed `[get]`

Detailed Description

Add this script to a trigger collider2D to teleport objects from that object to its destination

Member Enumeration Documentation

◆ CameraModes

enum MoreMountains.CorgiEngine.Teleporter.CameraModes

strong

the possible modes the teleporter can interact with the camera system on activation, either doing nothing, teleporting the camera to a new position, or blending between Cinemachine virtual cameras

Enumerator
DoNothing
TeleportCamera
CinemachinePriority

◆ TeleportationModes

enum MoreMountains.CorgiEngine.Teleporter.TeleportationModes

strong

the possible teleportation modes (either 1-frame instant teleportation, or tween between this teleporter and its destination)

Enumerator
Instant
Tween

Member Function Documentation

◆ AddToIgnoreList()

virtual void MoreMountains.CorgiEngine.Teleporter.AddToIgnoreList ( Transform objectToIgnore )

virtual

Adds an object to the ignore list, which will prevent that object to be moved by the teleporter while it's in that list

Parameters

objectToIgnore Object to ignore.

◆ AfterDelayBetweenFades()

virtual void MoreMountains.CorgiEngine.Teleporter.AfterDelayBetweenFades ( Collider2D collider )

protectedvirtual

Describes the events happening after the pause between the fade in and the fade out

◆ AfterFadeIn()

virtual void MoreMountains.CorgiEngine.Teleporter.AfterFadeIn ( Collider2D collider )

protectedvirtual

Describes the events happening after the fade in of the scene

Parameters

collider

◆ AfterFadeOut()

virtual void MoreMountains.CorgiEngine.Teleporter.AfterFadeOut ( Collider2D collider )

protectedvirtual

Describes the events happening once the initial fade in is complete

◆ AfterInitialDelay()

virtual void MoreMountains.CorgiEngine.Teleporter.AfterInitialDelay ( Collider2D collider )

protectedvirtual

Describes the events happening after the initial delay has passed

Parameters

collider

◆ Awake()

virtual void MoreMountains.CorgiEngine.Teleporter.Awake ( )

protectedvirtual

On start we initialize our ignore list

◆ BetweenFades()

virtual void MoreMountains.CorgiEngine.Teleporter.BetweenFades ( Collider2D collider )

protectedvirtual

Describes what happens midway through the fade

Parameters

collider

◆ InitializeTeleporter()

virtual void MoreMountains.CorgiEngine.Teleporter.InitializeTeleporter ( )

protectedvirtual

Grabs the current room in the parent if needed

◆ OnDrawGizmos()

virtual void MoreMountains.CorgiEngine.Teleporter.OnDrawGizmos ( )

protectedvirtual

On draw gizmos, we draw arrows to the target destination and target room if there are any

◆ OnTriggerEnter2D()

override void MoreMountains.CorgiEngine.Teleporter.OnTriggerEnter2D ( Collider2D collider )

protectedvirtual

Triggered when something enters the teleporter

Parameters

collider Collider.

Reimplemented from MoreMountains.CorgiEngine.ButtonActivated.

◆ OnTriggerStay2D()

override void MoreMountains.CorgiEngine.Teleporter.OnTriggerStay2D ( Collider2D collidingObject )

protectedvirtual

On stay we invoke our stay event if needed, and perform a trigger enter check if it hasn't been done already

Parameters

collidingObject

Reimplemented from MoreMountains.CorgiEngine.ButtonActivated.

◆ SequenceEnd()

virtual void MoreMountains.CorgiEngine.Teleporter.SequenceEnd ( Collider2D collider )

protectedvirtual

Describes the events happening after the fade out is complete, so at the end of the teleport sequence

◆ SequenceStart()

virtual void MoreMountains.CorgiEngine.Teleporter.SequenceStart ( Collider2D collider )

protectedvirtual

Describes the events happening before the initial fade in

Parameters

collider

◆ Teleport()

virtual void MoreMountains.CorgiEngine.Teleporter.Teleport ( Collider2D collider )

protectedvirtual

Teleports whatever enters the portal to a new destination

◆ TeleportCollider()

virtual void MoreMountains.CorgiEngine.Teleporter.TeleportCollider ( Collider2D collider )

protectedvirtual

Teleports the object going through the teleporter, either instantly or by tween

Parameters

collider

◆ TeleportSequence()

virtual IEnumerator MoreMountains.CorgiEngine.Teleporter.TeleportSequence ( Collider2D collider )

protectedvirtual

Handles the teleport sequence (fade in, pause, fade out)

Parameters

collider

Returns

◆ TeleportTweenCo()

virtual IEnumerator MoreMountains.CorgiEngine.Teleporter.TeleportTweenCo	(	Collider2D	collider,
		Vector3	origin,
		Vector3	destination
	)

protectedvirtual

Tweens the object from origin to destination

Parameters

collider
origin
destination

Returns

◆ TriggerButtonAction()

override void MoreMountains.CorgiEngine.Teleporter.TriggerButtonAction ( GameObject instigator )

virtual

If we're button activated and if the button is pressed, we teleport

Reimplemented from MoreMountains.CorgiEngine.ButtonActivated.

◆ TriggerExitAction()

override void MoreMountains.CorgiEngine.Teleporter.TriggerExitAction ( GameObject collider )

virtual

When something exits the teleporter, if it's on the ignore list, we remove it from it, so it'll be considered next time it enters.

Parameters

collider Collider.

Reimplemented from MoreMountains.CorgiEngine.ButtonActivated.

Member Data Documentation

◆ _entryPosition

Vector3 MoreMountains.CorgiEngine.Teleporter._entryPosition

protected

◆ _fadeInDurationWaitForSeconds

WaitForSecondsRealtime MoreMountains.CorgiEngine.Teleporter._fadeInDurationWaitForSeconds

protected

◆ _fadeInDurationWaitForSecondsScaled

WaitForSeconds MoreMountains.CorgiEngine.Teleporter._fadeInDurationWaitForSecondsScaled

protected

◆ _fadeOutDurationWaitForSeconds

WaitForSecondsRealtime MoreMountains.CorgiEngine.Teleporter._fadeOutDurationWaitForSeconds

protected

◆ _fadeOutDurationWaitForSecondsScaled

WaitForSeconds MoreMountains.CorgiEngine.Teleporter._fadeOutDurationWaitForSecondsScaled

protected

◆ _finalDelayyWaitForSeconds

WaitForSecondsRealtime MoreMountains.CorgiEngine.Teleporter._finalDelayyWaitForSeconds

protected

◆ _finalDelayyWaitForSecondsScaled

WaitForSeconds MoreMountains.CorgiEngine.Teleporter._finalDelayyWaitForSecondsScaled

protected

◆ _halfDelayBetweenFadesWaitForSeconds

WaitForSecondsRealtime MoreMountains.CorgiEngine.Teleporter._halfDelayBetweenFadesWaitForSeconds

protected

◆ _halfDelayBetweenFadesWaitForSecondsScaled

WaitForSeconds MoreMountains.CorgiEngine.Teleporter._halfDelayBetweenFadesWaitForSecondsScaled

protected

◆ _ignoreList

List<Transform> MoreMountains.CorgiEngine.Teleporter._ignoreList

protected

◆ _initialDelayWaitForSeconds

WaitForSecondsRealtime MoreMountains.CorgiEngine.Teleporter._initialDelayWaitForSeconds

protected

◆ _initialDelayWaitForSecondsScaled

WaitForSeconds MoreMountains.CorgiEngine.Teleporter._initialDelayWaitForSecondsScaled

protected

◆ _newPosition

Vector3 MoreMountains.CorgiEngine.Teleporter._newPosition

protected

◆ AddToDestinationIgnoreList

bool MoreMountains.CorgiEngine.Teleporter.AddToDestinationIgnoreList = true

if this is true, the teleported object will be put on the destination's ignore list, to prevent immediate re-entry. If your destination's offset is far enough from its center, you can set that to false

◆ AfterDelayBetweenFadesFeedback

MMFeedbacks MoreMountains.CorgiEngine.Teleporter.AfterDelayBetweenFadesFeedback

a feedback that will get played at the start of the fade in

◆ AfterFadeOutFeedback

MMFeedbacks MoreMountains.CorgiEngine.Teleporter.AfterFadeOutFeedback

a feedback that will get played at the start of the delay between fades

◆ AfterInitialDelayFeedback

MMFeedbacks MoreMountains.CorgiEngine.Teleporter.AfterInitialDelayFeedback

a feedback that will get played at the start of the fade out duration

◆ ArrivedHereFeedback

MMFeedbacks MoreMountains.CorgiEngine.Teleporter.ArrivedHereFeedback

a feedback that gets played on this teleporter when another teleporter sends a character here

◆ CameraMode

CameraModes MoreMountains.CorgiEngine.Teleporter.CameraMode = CameraModes.TeleportCamera

the chosen camera mode

◆ CurrentRoom

Room MoreMountains.CorgiEngine.Teleporter.CurrentRoom

the room this teleporter belongs to

◆ DelayBetweenFades

float MoreMountains.CorgiEngine.Teleporter.DelayBetweenFades = 0.3f

the duration (in seconds) to wait for after the fade out and before the fade in

◆ Destination

Teleporter MoreMountains.CorgiEngine.Teleporter.Destination

the teleporter's destination

◆ ExitOffset

Vector3 MoreMountains.CorgiEngine.Teleporter.ExitOffset

the offset to apply when exiting this teleporter

◆ FadeInDuration

float MoreMountains.CorgiEngine.Teleporter.FadeInDuration = 0.2f

the duration (in seconds) after the initial delay covering for the fade in of the scene

◆ FadeOutDuration

float MoreMountains.CorgiEngine.Teleporter.FadeOutDuration = 0.2f

the duration (in seconds) after the initial delay covering for the fade out of the scene

◆ FaderID

int MoreMountains.CorgiEngine.Teleporter.FaderID = 0

the ID of the fader to target

◆ FadeTween

MMTweenType MoreMountains.CorgiEngine.Teleporter.FadeTween = new MMTweenType(MMTween.MMTweenCurve.EaseInCubic)

the curve to use to fade to black

◆ FinalDelay

float MoreMountains.CorgiEngine.Teleporter.FinalDelay = 0.1f

the duration (in seconds) to apply after the fade in of the scene

◆ FreezeCharacter

bool MoreMountains.CorgiEngine.Teleporter.FreezeCharacter = true

whether or not the character should be frozen (input blocked) for the duration of the transition

◆ FreezeTime

bool MoreMountains.CorgiEngine.Teleporter.FreezeTime = false

whether or not time should be frozen during the transition

◆ InitialDelay

float MoreMountains.CorgiEngine.Teleporter.InitialDelay = 0.1f

the delay (in seconds) to apply before running the sequence

◆ MaintainXEntryPositionOnExit

bool MoreMountains.CorgiEngine.Teleporter.MaintainXEntryPositionOnExit = false

whether or not to maintain the x value of the teleported object on exit

◆ MaintainYEntryPositionOnExit

bool MoreMountains.CorgiEngine.Teleporter.MaintainYEntryPositionOnExit = false

whether or not to maintain the y value of the teleported object on exit

◆ MoveMask

bool MoreMountains.CorgiEngine.Teleporter.MoveMask = true

whether or not we should ask to move a MMSpriteMask on activation

◆ MoveMaskCurve

MMTween.MMTweenCurve MoreMountains.CorgiEngine.Teleporter.MoveMaskCurve = MMTween.MMTweenCurve.EaseInCubic

the curve to move the mask along to

◆ MoveMaskDuration

float MoreMountains.CorgiEngine.Teleporter.MoveMaskDuration = 0.2f

the duration of the mask movement (usually the same as the DelayBetweenFades

◆ MoveMaskMethod

MMSpriteMaskEvent.MMSpriteMaskEventTypes MoreMountains.CorgiEngine.Teleporter.MoveMaskMethod = MMSpriteMaskEvent.MMSpriteMaskEventTypes.ExpandAndMoveToNewPosition

the method to move the mask

◆ OnlyAffectsPlayer

bool MoreMountains.CorgiEngine.Teleporter.OnlyAffectsPlayer = true

if true, this won't teleport non player characters

◆ ResetMovementStateOnTeleport

bool MoreMountains.CorgiEngine.Teleporter.ResetMovementStateOnTeleport = false

whether or not to reset movement state on the character as it teleports

◆ SequenceEndFeedback

MMFeedbacks MoreMountains.CorgiEngine.Teleporter.SequenceEndFeedback

a feedback that will get played at the start of the final delay

◆ SequenceStartFeedback

MMFeedbacks MoreMountains.CorgiEngine.Teleporter.SequenceStartFeedback

a feedback that will get played when the initial delay starts

◆ TargetRoom

Room MoreMountains.CorgiEngine.Teleporter.TargetRoom

the target room

◆ TeleportationMode

TeleportationModes MoreMountains.CorgiEngine.Teleporter.TeleportationMode = TeleportationModes.Instant

the selected teleportation mode

◆ TimescaleMode

TimescaleModes MoreMountains.CorgiEngine.Teleporter.TimescaleMode = TimescaleModes.Scaled

whether to operate the teleport sequence on scaled or unscaled time

◆ TriggerFade

bool MoreMountains.CorgiEngine.Teleporter.TriggerFade = false

if this is true, a fade to black will occur when teleporting

◆ TweenCurve

MMTween.MMTweenCurve MoreMountains.CorgiEngine.Teleporter.TweenCurve = MMTween.MMTweenCurve.EaseInCubic

the curve to apply to the teleportation tween

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

Assets/CorgiEngine/Common/ScriptsCinemachine/Environment/Teleporter.cs

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ CameraModes

◆ TeleportationModes

Member Function Documentation

◆ AddToIgnoreList()

◆ AfterDelayBetweenFades()

◆ AfterFadeIn()

◆ AfterFadeOut()

◆ AfterInitialDelay()

◆ Awake()

◆ BetweenFades()

◆ InitializeTeleporter()

◆ OnDrawGizmos()

◆ OnTriggerEnter2D()

◆ OnTriggerStay2D()

◆ SequenceEnd()

◆ SequenceStart()

◆ Teleport()

◆ TeleportCollider()

◆ TeleportSequence()

◆ TeleportTweenCo()

◆ TriggerButtonAction()

◆ TriggerExitAction()

Member Data Documentation

◆ _entryPosition

◆ _fadeInDurationWaitForSeconds

◆ _fadeInDurationWaitForSecondsScaled

◆ _fadeOutDurationWaitForSeconds

◆ _fadeOutDurationWaitForSecondsScaled

◆ _finalDelayyWaitForSeconds

◆ _finalDelayyWaitForSecondsScaled

◆ _halfDelayBetweenFadesWaitForSeconds

◆ _halfDelayBetweenFadesWaitForSecondsScaled

◆ _ignoreList

◆ _initialDelayWaitForSeconds

◆ _initialDelayWaitForSecondsScaled

◆ _newPosition

◆ AddToDestinationIgnoreList

◆ AfterDelayBetweenFadesFeedback

◆ AfterFadeOutFeedback

◆ AfterInitialDelayFeedback

◆ ArrivedHereFeedback

◆ CameraMode

◆ CurrentRoom

◆ DelayBetweenFades

◆ Destination

◆ ExitOffset

◆ FadeInDuration

◆ FadeOutDuration

◆ FaderID

◆ FadeTween

◆ FinalDelay

◆ FreezeCharacter

◆ FreezeTime

◆ InitialDelay

◆ MaintainXEntryPositionOnExit

◆ MaintainYEntryPositionOnExit

◆ MoveMask

◆ MoveMaskCurve

◆ MoveMaskDuration

◆ MoveMaskMethod

◆ OnlyAffectsPlayer

◆ ResetMovementStateOnTeleport

◆ SequenceEndFeedback

◆ SequenceStartFeedback

◆ TargetRoom

◆ TeleportationMode

◆ TimescaleMode

◆ TriggerFade

◆ TweenCurve