Status Behaviors let your character apply a lasting gameplay change to another Rival — a burn that ticks damage, a cooldown that blocks a special, a mark that changes what your next hit does. They are written in Lua and registered through a Blueprint asset.<\/p>\n\n\n\n
Before making a status behavior, consider whether it couldn’t be better implemented by logic directly on your character. The two criteria below work as a good rule of thumb for when a status makes sense:<\/p>\n\n\n\n
Statuses come in two varieties, both of which will inherit from RivalsStatusBehaviorBase:<\/p>\n\n\n\n
In general: if the Rival can keep acting during the state, it’s a Status Effect. If not, it’s a Custom Status State.<\/p>\n\n\n\n
In your mod’s\u00a0 Create the Lua file at the path you entered. The script defines one global table, named exactly the same as your\u00a0Lua Metatable Name<\/strong>.<\/p>\n\n\n\n There are numerous functions that Status Effects can implement, check the Lua documentation for more info. Note that StatusEffectValues are NetProps, and thus must be accessed with GetValue\/SetValue.<\/p>\n\n\n\n Your effect can’t be used until something registers it. Open your CharacterData or ArticleData asset and add your new Blueprint class to the Manipulating status effects is mostly done via 3 self-explanatory functions:<\/p>\n\n\n\n Note that status effects do not inherently have a duration. If you want a duration-based status effect, you’ll typically use the stack counter as a timer and tick it down in the effect’s Update function.<\/p>\n\n\n\n Multiple instances of the same status will be resolved differently depending on whether Is Exclusive<\/strong> is set on the effect’s Blueprint. When true, the status will remove any prior instances before being applied. When false, multiple instances will coexist simultaneously, tick their functions seperately, and GetStatusEffectValue will return the value of the first instance found.<\/p>\n\n\n\n Every effect is stored under a namespaced key,\u00a0 You do not have to type this prefix.<\/strong> When your script passes in a plain name like “Burn”, the game automatically prefixes your own ModID. You only need to think about this when invoking a status effect defined outside your own mod.<\/p>\n\n\n\n You can only ever register<\/em> an effect in your own mod’s namespace.<\/p>\n\n\n\n There are two ways to implement a status effect visual.<\/p>\n\n\n\n On your Blueprint, add an entry to the Status Visual Definitions map using your effect’s short-name as a key. The properties on this allow you to manipulate the affected Rival’s tint, outline, and aura.<\/p>\n\n\n\n Colors in a Status Visual Definition are\u00a0palette slot names, not raw color values<\/strong>.\u00a0Default Color Palette<\/strong>\u00a0provides fallback values when the inflictor has no matching palette of their own.\u00a0<\/p>\n\n\n\n You can also implement For effects that can’t be easily expressed with a Status Visual Definition, you can create your own renderer Actor and assign it to Visual Renderer Class<\/strong> on the Status Effect Blueprint.<\/p>\n\n\n\n To play SFX or VFX, you can set up the SFX Container Class<\/strong> and VFX Container Class<\/strong> and then invoke them from scripts:<\/p>\n\n\n\n The inflictor can also be supplied as an optional third parameter. If the named effects are defined on the inflictor’s skin, it will use those instead of the ones on the Status Effect.<\/p>\n\n\n\n Authoring a Custom Status State follows the same shape as a Status Effect, with three differences:<\/p>\n\n\n\n Custom Status States can be applied via SetCustomStatusState:<\/p>\n\n\n\n The important element here is the last parameter, which is the State Name<\/strong> on your Blueprint. The type will always be CustomStatus1.<\/p>\n\n\n\n Your script then drives the state by implementing various functions in its script, see the Lua documentation for more details.<\/p>\n\n\n\n Status Effect Hooks:<\/span><\/p>\n\n\n\n Return true from any of these functions to remove the effect.<\/p>\n\n\n\n Additional Status Effect Hooks:<\/span><\/p>\n\n\n\n Custom Status State Hooks<\/span><\/p>\n\n\n\n <\/p>\n","protected":false},"excerpt":{"rendered":" Status Behaviors let your character apply a lasting gameplay change to another Rival — a burn that ticks damage, a cooldown that blocks a special, a mark that changes what your next hit does. They are written in Lua and registered through a Blueprint asset. When to use a Status Behavior Before making a status […]<\/p>\n","protected":false},"author":9,"featured_media":0,"comment_status":"open","ping_status":"open","template":"","knowledgebase_cat":[4],"knowledgebase_tag":[],"class_list":["post-1125","knowledgebase","type-knowledgebase","status-publish","hentry","knowledgebase_cat-character-creation"],"_links":{"self":[{"href":"https:\/\/rivals2.com\/workshop\/wp-json\/wp\/v2\/knowledgebase\/1125","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/rivals2.com\/workshop\/wp-json\/wp\/v2\/knowledgebase"}],"about":[{"href":"https:\/\/rivals2.com\/workshop\/wp-json\/wp\/v2\/types\/knowledgebase"}],"author":[{"embeddable":true,"href":"https:\/\/rivals2.com\/workshop\/wp-json\/wp\/v2\/users\/9"}],"replies":[{"embeddable":true,"href":"https:\/\/rivals2.com\/workshop\/wp-json\/wp\/v2\/comments?post=1125"}],"version-history":[{"count":5,"href":"https:\/\/rivals2.com\/workshop\/wp-json\/wp\/v2\/knowledgebase\/1125\/revisions"}],"predecessor-version":[{"id":1756,"href":"https:\/\/rivals2.com\/workshop\/wp-json\/wp\/v2\/knowledgebase\/1125\/revisions\/1756"}],"wp:attachment":[{"href":"https:\/\/rivals2.com\/workshop\/wp-json\/wp\/v2\/media?parent=1125"}],"wp:term":[{"taxonomy":"knowledgebase_cat","embeddable":true,"href":"https:\/\/rivals2.com\/workshop\/wp-json\/wp\/v2\/knowledgebase_cat?post=1125"},{"taxonomy":"knowledgebase_tag","embeddable":true,"href":"https:\/\/rivals2.com\/workshop\/wp-json\/wp\/v2\/knowledgebase_tag?post=1125"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}UnrealAssets<\/code>\u00a0folder, create a Blueprint whose parent class is\u00a0RivalsLuaStatusEffectBase<\/strong>. Open it and set three properties on the Class Defaults:<\/p>\n\n\n\n\n
1234567890\/Scripts\/MyStatusEffect.lua<\/code><\/li>\n\n\n\n2: Write the Script<\/h4>\n\n\n\n
MyStatusEffect = {}\n\n-- Runs every frame while the effect is active.\n-- Return true to remove the effect.\nfunction MyStatusEffect.Update( StatusEffect, Target )\n local value = StatusEffect.StatusEffectValue:GetValue()\n value = value - 1\n StatusEffect.StatusEffectValue:SetValue( value )\n\n if ( value <= 0 ) then\n return true\n end\n return false\nend<\/code><\/pre>\n\n\n\n3. Register the effect<\/h4>\n\n\n\n
Status Effect Behavior Classes<\/code> array.<\/p>\n\n\n\nUsing an Effect<\/h3>\n\n\n\n
\n
Naming and Mod Namespaces<\/h3>\n\n\n\n
<YourModID>.<EffectName><\/code>. This allows two mods to both ship an effect called\u00a0Burn<\/code>\u00a0without conflict. Base game effects have no prefix.<\/p>\n\n\n\n\n
Visuals<\/h3>\n\n\n\n
1. Status Visual Definition<\/h4>\n\n\n\n
GetVisual<\/code> on your status effect to programatically provide a status effect at runtime, allowing you to change the values dynamically.<\/p>\n\n\n\n2. Visual Renderer Class<\/h4>\n\n\n\n
SFX and VFX<\/h3>\n\n\n\n
self:PlaySFX( Target, \"MySound\" )\nself:SpawnVfx( Target, \"MyEffect\" )<\/code><\/pre>\n\n\n\nCustom Status States<\/h3>\n\n\n\n
\n
Target:SetCustomStatusState( ERivalsCharacterState.CustomStatus1, self:GetEntityIndex(), \"MyState\" )<\/code><\/pre>\n\n\n\nFunction Reference<\/h3>\n\n\n\n
Hook<\/th> Runs when<\/th><\/tr><\/thead> Update<\/code><\/td>Every frame<\/td><\/tr> UpdatePostMovement<\/code><\/td>Every frame, after movement resolves<\/td><\/tr> UpdateInHitpause<\/code><\/td>Every frame during hitpause<\/td><\/tr> UpdateOnHitboxImpact<\/code><\/td>The Rival is struck. Also receives the hitbox<\/td><\/tr> UpdateOnHitRival<\/code><\/td>The Rival hits someone. Also receives the Rival hit<\/td><\/tr> UpdateOnHitShield<\/code><\/td>The Rival hits a shield. Also receives the shielding Rival<\/td><\/tr> UpdateOnInitState<\/code><\/td>The Rival changes state<\/td><\/tr> UpdateOnKnockback<\/code><\/td>The Rival takes knockback<\/td><\/tr> UpdateOnTechableHitstunEnd<\/code><\/td>Techable hitstun ends<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Hook<\/th>Runs when<\/th><\/tr><\/thead> OnOwnerHitBlastzone<\/code><\/td>Fires when the player this the blast zone. Returning true prevents death instead of removing the effect — it must be removed manually instead.<\/td><\/tr> OnRemoved<\/code><\/td>Runs when the effect ends. No return value.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Hook<\/th> Purpose<\/th><\/tr><\/thead> Start<\/code>, End<\/code>, EndNaturally<\/code><\/td>Lifecycle. EndNaturally<\/code> runs when the state times out rather than being cut short<\/td><\/tr>Update<\/code>, UpdatePostMovement<\/code>, UpdateTimer<\/code><\/td>Per frame<\/td><\/tr> GetLength<\/code><\/td>How many frames the state lasts<\/td><\/tr> GetIasaFrame<\/code><\/td>When the Rival can act again<\/td><\/tr> GetOverlays<\/code><\/td>Visual overlays<\/td><\/tr> GetVisual<\/code><\/td>Visual treatment<\/td><\/tr> CanHitboxHitTarget<\/code><\/td>Whether a given hitbox can connect<\/td><\/tr> ApplyKnockbackToTarget<\/code><\/td>Custom knockback response<\/td><\/tr> TakeDamage<\/code><\/td>Custom damage response<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n