Configuring Humanoid Data

To set the Humanoid Data of your status effect you can use a built-in method SetHumanoidData(). Let's modify our stun status to set the player's WalkSpeed to zero.

note

You can use SetHumanoidData() method on client, however the changes will be overriden with a next server change of Humanoid Data.

TypeScript

attack.ts

import { StatusEffect, StatusEffectDecorator } from "@rbxts/wcs";

@StatusEffectDecorator
export class Stun extends StatusEffect {
	public OnStartServer() {
		this.SetHumanoidData({ WalkSpeed: [0, "Set"] })
	}
}

Luau

attack.lua

local ReplicatedStorage = game:GetService("ReplicatedStorage")
local WCS = require(ReplicatedStorage.WCS)

local Stun = WCS.RegisterStatusEffect("Stun")

function Stun:OnStartServer()
	self:SetHumanoidData({ WalkSpeed = {0, "Set" } })
end

return Stun

warning

Luau types for Humanoid Data are not accurate, the value of a property is represented as {number, "Set" | "Increment"}. It is currently impossible to type specific indexes of an array unlike typescript, so you will be faced with an error if you provide the arguments in the wrong order.