RiskofThunder-R2API_Dot icon

R2API Dot

API for adding custom damage over time effects

Last updated a year ago
Total downloads 1448390
Total rating 5 
Categories Libraries
Dependency string RiskofThunder-R2API_Dot-1.0.1
Dependants 726 other packages depend on this package

This mod requires the following mods to function

bbepis-BepInExPack-5.4.2109 icon
bbepis-BepInExPack

Unified BepInEx all-in-one modding pack - plugin framework, detour library

Preferred version: 5.4.2109
RiskofThunder-HookGenPatcher-1.2.3 icon
RiskofThunder-HookGenPatcher

MMHOOK generation at runtime.

Preferred version: 1.2.3
RiskofThunder-R2API_Core-5.0.8 icon
RiskofThunder-R2API_Core

Core R2API module

Preferred version: 5.0.8

README

R2API.Dot - Custom Damage over time effects

About

R2API.Dot is a submodule assembly for R2API that allows mod creators to add new Damage over time effects to the game, DOT's include the game's Burn, Bleeding, and more.

Use Cases / Features

R2API.Dot is used for adding new DotIndices and DotDefs to the game's DotController, this is done via the RegisterDotDef method.

Alongside adding new DotIndices and DotDefs, One can also provide CustomDotBehaviours and CustomDotVisuals, these are Delegates that are used for giving extra features to your DamageOverTime effects.

  • CustomDotBehaviour: Runs the delegate after AddDot succesfully adds your DamageOverTime
  • CustomDotVisual: Functions like a FixedUpdate method for your dot, use this to handle the Visual effect of your DOT.

Related Pages

Changelog

'1.0.1'

  • Fix the NuGet package which had a dependency on a non-existent version of R2API.Core.

'1.0.0'

  • Split from the main R2API.dll into its own submodule.