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. |
DUNGEON:LastDungeonResult
Gets the result of the last dungeon adventure. Takes no arguments.
Usage
DungeonCurrentFloor
Returns the floor number of the current dungeon. Takes no arguments.
Usage
DungeonAssetName
Returns the internal name for the current dungeon. Takes no arguments.
Usage
DungeonDisplayName
Returns the localized name of the current dungeon. Takes no arguments.
Usage
DUNGEON:CharSetEmote(RogueEssence.Dungeon.Character,System.String,System.Int32)
Set a character's emote in a dungeon map.
Arguments
chara: Character to emoteemoteid: ID of the emotecycles: The number of times to play the emote.
DUNGEON:CharStartAnim
Set a character's animation.
Arguments
chara: Character to animateanim: Name of the animationloop: Whether to loop the animation
Example
DUNGEON:CharStartAnim(player, anim, false)
DUNGEON:CharEndAnim
Stops a character's current animation, reverting them to default idle.
Arguments
chara: Character to stop animating
Example
DUNGEON:CharEndAnim(player)
DUNGEON:CharWaitAnim
Set a character's animation, and waits until it completed before continue.
Arguments
chara: Character to animateanim: Name of the animation
Example
DUNGEON:CharStartAnim(player, anim)
DUNGEON:PlayVFX(RogueEssence.Content.FiniteEmitter,System.Int32,System.Int32,RogueElements.Dir8)
Plays a VFX in the dungeon map
Arguments
emitter: The VFX emitterx: X position in pixelsy: Y Position in pixelsdir: Direction to orient the VFX, defaults to Down
DUNGEON:PlayVFX(RogueEssence.Content.FiniteEmitter,System.Int32,System.Int32,RogueElements.Dir8,System.Int32,System.Int32)
Plays a VFX that has a start position and an end position. It uses a finite emitter that generates BaseAnims.
Arguments
emitter: The VFX emitterx: Start X position in pixelsy: Start Y Position in pixelsdir: Direction to orient the VFX, defaults to Down.xTo: End X position in pixelsyTo: End Y position in pixels
DUNGEON:PlayVFXAnim(RogueEssence.Content.BaseAnim,RogueEssence.Content.DrawLayer)
Plays a VFX using just a BaseAnim
Arguments
anim: The animation to playlayer: The layer to put it on
DUNGEON:MoveScreen(RogueEssence.Content.ScreenMover)
Plays a screen-moving effect.
Arguments
mover: The screen mover.
