Dungeon (functions)

The dungeon functions involve actions that are performed within dungeons.

CharTurnToChar

Makes a character turn to face another.

Arguments

Argument order is DUNGEON:CharTurnToChar(curch, turnto).

Name	Type	Technical Type	Purpose
curch	Dungeon Character	RogueEssence.Dungeon.Character	The character that will turn.
turnto	Dungeon Character	RogueEssence.Dungeon.Character	The character being turned to.

LastDungeonResult

Gets the result of the last dungeon adventure. Takes no arguments.

Usage

This section is a stub. You can help PMDO Wiki by expanding it.

DungeonCurrentFloor

Returns the floor number of the current dungeon. Takes no arguments.

Usage

This section is a stub. You can help PMDO Wiki by expanding it.

DungeonAssetName

Returns the internal name for the current dungeon. Takes no arguments.

Usage

This section is a stub. You can help PMDO Wiki by expanding it.

DungeonDisplayName

Returns the localized name of the current dungeon. Takes no arguments.

CharSetEmote

Set a character's emote in a dungeon map. Argument order is DUNGEON:CharSetEmote(chara, emoteID, cycles).

Arguments

Name	Type	Technical Type	Purpose
chara	Dungeon Character	RogueEssence.Dungeon.Character	Character to emote
emoteID	String	System.String	ID of the emote
emoteID	Integer	System.Int32	The number of times to play the emote.

CharStartAnim

Set a character's animation. Argument order is DUNGEON:CharStartAnim(chara, emoteID, doLoop)

Name	Type	Technical Type	Purpose
chara	Dungeon Character	RogueEssence.Dungeon.Character	Character to animate
emoteID	String	System.String	Name of the animation
doLoop	Boolean	System.Bool	Whether to loop the animation

Example

DUNGEON:CharStartAnim(player, anim, false)

DUNGEON:CharEndAnim

Stops a character's current animation, reverting them to default idle. Usage is DUNGEON:CharEndAnim(chara).

Arguments

• chara: Character to stop animating

Name	Type	Technical Type	Purpose
chara	Dungeon Character	RogueEssence.Dungeon.Character	Character to stop animating

Example

DUNGEON:CharEndAnim(player)

CharWaitAnim

Set a character's animation, and waits until it completed before continue. Usage is CharWaitAnim(chara, anim).

Arguments

} {

Name	Type	Technical Type	Purpose
chara	Character	-	The character to animate.
anim	String	-	The string name of the animation.

Example

DUNGEON:CharStartAnim(player, anim)

PlayVFX

Plays a VFX in the dungeon map. Usage is DUNGEON:PlayVFX(emitter, x, y, dir).

Arguments

name=emitter name=X name=Y name=dir

Name	Type	Technical Type	Purpose

PlayVFX

Plays a VFX that has a start position and an end position. It uses a finite emitter that generates BaseAnims. Argument order is DUNGEON:PlayVFX(emitter, x, y, dir, xTo, yTo).

Arguments

name=emitter name=x name=y name=dir name=xTo name=yTo

Name	Type	Technical Type	Purpose

PlayVFXAnim

Plays a VFX using just a BaseAnim. Argument order is DUNGEON:PlayVFXAnim(anim, layer).

Arguments

name=anim name=layer

Name	Type	Technical Type	Purpose

MoveScreen

Plays a screen-moving effect. Argument order is DUNGEON:MoveScreen(mover).

Arguments

name=mover

Name	Type	Technical Type	Purpose