root/org.magiclib.plugins/MagicCampaignTrailPlugin

MagicCampaignTrailPlugin

Constructors

constructor()

Functions

open fun AddTrailMemberAdvanced(linkedEntity: SectorEntityToken, ID: Float, sprite: SpriteAPI, position: Vector2f, startSpeed: Float, endSpeed: Float, angle: Float, startAngularVelocity: Float, endAngularVelocity: Float, startSize: Float, endSize: Float, startColor: Color, endColor: Color, opacity: Float, inDuration: Float, mainDuration: Float, outDuration: Float, blendModeSRC: Int, blendModeDEST: Int, textureLoopLength: Float, textureScrollSpeed: Float, offsetVelocity: Vector2f, locationAPICulling: Boolean, locationAPI: LocationAPI)

addTrailMemberAdvanced

open fun addTrailMemberAdvanced(linkedEntity: SectorEntityToken, ID: Float, sprite: SpriteAPI, position: Vector2f, startSpeed: Float, endSpeed: Float, angle: Float, startAngularVelocity: Float, endAngularVelocity: Float, startSize: Float, endSize: Float, startColor: Color, endColor: Color, opacity: Float, inDuration: Float, mainDuration: Float, outDuration: Float, blendModeSRC: Int, blendModeDEST: Int, textureLoopLength: Float, textureScrollSpeed: Float, offsetVelocity: Vector2f, locationAPICulling: Boolean, locationAPI: LocationAPI)

Spawns a trail piece, which links up with other pieces with the same ID to form a smooth trail.

AddTrailMemberAnimated

open fun AddTrailMemberAnimated(linkedEntity: SectorEntityToken, ID: Float, sprite: SpriteAPI, position: Vector2f, startSpeed: Float, endSpeed: Float, angle: Float, startAngularVelocity: Float, endAngularVelocity: Float, startSize: Float, endSize: Float, startColor: Color, endColor: Color, opacity: Float, inDuration: Float, mainDuration: Float, outDuration: Float, blendModeSRC: Int, blendModeDEST: Int, textureLoopLength: Float, textureScrollSpeed: Float, offsetVelocity: Vector2f, locationAPICulling: Boolean, locationAPI: LocationAPI)

addTrailMemberAnimated

open fun addTrailMemberAnimated(linkedEntity: SectorEntityToken, ID: Float, sprite: SpriteAPI, position: Vector2f, startSpeed: Float, endSpeed: Float, angle: Float, startAngularVelocity: Float, endAngularVelocity: Float, startSize: Float, endSize: Float, startColor: Color, endColor: Color, opacity: Float, inDuration: Float, mainDuration: Float, outDuration: Float, blendModeSRC: Int, blendModeDEST: Int, textureLoopLength: Float, textureScrollSpeed: Float, offsetVelocity: Vector2f, locationAPICulling: Boolean, locationAPI: LocationAPI)

Spawns a trail piece, which links up with other pieces with the same ID to form a smooth trail.

AddTrailMemberSimple

open fun AddTrailMemberSimple(linkedEntity: SectorEntityToken, ID: Float, sprite: SpriteAPI, position: Vector2f, speed: Float, angle: Float, startSize: Float, endSize: Float, color: Color, opacity: Float, duration: Float, additive: Boolean, offsetVelocity: Vector2f)

addTrailMemberSimple

open fun addTrailMemberSimple(linkedEntity: SectorEntityToken, ID: Float, sprite: SpriteAPI, position: Vector2f, speed: Float, angle: Float, startSize: Float, endSize: Float, color: Color, opacity: Float, duration: Float, additive: Boolean, offsetVelocity: Vector2f)

Spawns a trail piece, which links up with other pieces with the same ID to form a smooth trail.

advance

open fun advance(amount: Float)

cutTrailsOnEntity

open fun cutTrailsOnEntity(entity: SectorEntityToken)

"Cuts" all trails on a designated entity, forcing new trail pieces to not link up with old ones.

getUniqueID

open fun getUniqueID(): Float

A small function to get a unique ID for the trail member: *must* be saved in the function that generates the trail, since if it changes it counts as a new trail altogether

isDone

open fun isDone(): Boolean

render

open fun render(currentRenderLayer: CampaignEngineLayers, viewPort: ViewportAPI)

runWhilePaused

open fun runWhilePaused(): Boolean