Ground (functions)/Vfx
From PMDOWiki
More functions: Script Reference
This page documents the ScriptGround class for Lua scripting.
As a singleton class, it can be accessed from Lua with GROUND.
PlayVFX
GROUND:PlayVFX(emitter, x, y, dir)
Plays a VFX using a finite emitter that generates BaseAnims.
Parameters
| Name | Type | Description |
|---|---|---|
| RogueEssence.Content.FiniteEmitter | RogueEssence.Content.FiniteEmitter | The VFX emitter |
| System.Int32 | System.Int32 | X position |
| System.Int32 | System.Int32 | Y Position |
| RogueElements.Dir8 | RogueElements.Dir8 | Direction to orient the VFX, defaults to Down |
PlayVFX
GROUND:PlayVFX(emitter, x, y, dir, xTo, yTo)
Plays a VFX that has a start position and an end position. It uses a finite emitter that generates BaseAnims.
Parameters
| Name | Type | Description |
|---|---|---|
| RogueEssence.Content.FiniteEmitter | RogueEssence.Content.FiniteEmitter | The VFX emitter |
| System.Int32 | System.Int32 | Start X position |
| System.Int32 | System.Int32 | Start Y Position |
| RogueElements.Dir8 | RogueElements.Dir8 | Direction to orient the VFX, defaults to Down. |
| System.Int32 | System.Int32 | End X position |
| System.Int32 | System.Int32 | End Y position |
PlayVFXAnim
GROUND:PlayVFXAnim(anim, layer)
Plays a VFX using just a BaseAnim
Parameters
| Name | Type | Description |
|---|---|---|
| RogueEssence.Content.BaseAnim | RogueEssence.Content.BaseAnim | The animation to play |
| RogueEssence.Content.DrawLayer | RogueEssence.Content.DrawLayer | The layer to put it on |
MoveScreen
GROUND:MoveScreen(mover)
Plays a screen-moving effect.
Parameters
| Name | Type | Description |
|---|---|---|
| RogueEssence.Content.ScreenMover | RogueEssence.Content.ScreenMover | The screen mover. |
References
https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Lua/ScriptGroundVfx.cs
