Iftebinjan

CustomVitalsManager is a lightweight developer-focused Rust plugin for creating and managing custom player status effects using Rust’s native CustomVitalsInfo system. It allows other plugins to display custom vitals with icons, colors, left/right text, timers, active states, and automatic expiry handling directly in the player’s native status/vitals UI. Features Native Rust custom vitals support through ProtoBuf.CustomVitalInfo Shared/global vitals visible to all connected players Player-specific custom vitals Optional automatic expiry/removal Manual update, remove, clear, and resend APIs Developer hooks for blocking, tracking, and reacting to vital changes Uses pooled ProtoBuf objects for cleaner server-side memory handling Developer API |-------------------------------------------------------------------------- | CREATE: | CustomVitalInfo API_RentVitalInfo( | string icon = null, | string iconColor = null, | string backgroundColor = null, | string leftText = null, | string leftTextColor = null, | string rightText = null, | string rightTextColor = null, | int timeLeft = 0, | bool active = true | ); | | CustomVitalInfo API_RentVitalInfoRaw( | string icon = null, | Color iconColor = default(Color), | Color backgroundColor = default(Color), | string leftText = null, | Color leftTextColor = default(Color), | string rightText = null, | Color rightTextColor = default(Color), | int timeLeft = 0, | bool active = true | ); | |-------------------------------------------------------------------------- | ADD: | uint API_AddVital( | BasePlayer player, | CustomVitalInfo vital, | float expiry = 0f, | bool sendUpdate = true | ); | | uint API_AddVital( | BasePlayer player, | string icon = null, | string iconColor = null, | string backgroundColor = null, | string leftText = null, | string leftTextColor = null, | string rightText = null, | string rightTextColor = null, | int timeLeft = 0, | bool active = true, | float expiry = 0f, | bool sendUpdate = true | ); | | uint API_AddPlayerVital( | ulong playerId, | string icon = null, | string iconColor = null, | string backgroundColor = null, | string leftText = null, | string leftTextColor = null, | string rightText = null, | string rightTextColor = null, | int timeLeft = 0, | bool active = true, | float expiry = 0f, | bool sendUpdate = true | ); | | uint API_AddSharedVital( | CustomVitalInfo vital, | float expiry = 0f, | bool sendUpdate = true | ); | | uint API_AddSharedVital( | string icon = null, | string iconColor = null, | string backgroundColor = null, | string leftText = null, | string leftTextColor = null, | string rightText = null, | string rightTextColor = null, | int timeLeft = 0, | bool active = true, | float expiry = 0f, | bool sendUpdate = true | ); | |-------------------------------------------------------------------------- | UPDATE: | bool API_UpdateVitalText(BasePlayer player, uint id, string leftText = null, string rightText = null, bool sendUpdate = true); | bool API_UpdateVitalText(ulong playerId, uint id, string leftText = null, string rightText = null, bool sendUpdate = true); | bool API_UpdateSharedVitalText(uint id, string leftText = null, string rightText = null, bool sendUpdate = true); | | bool API_SetVitalActive(BasePlayer player, uint id, bool active, bool sendUpdate = true); | bool API_SetVitalActive(ulong playerId, uint id, bool active, bool sendUpdate = true); | bool API_SetSharedVitalActive(uint id, bool active, bool sendUpdate = true); | | bool API_SetVitalTimeLeft(BasePlayer player, uint id, int timeLeft, bool sendUpdate = true); | bool API_SetVitalTimeLeft(ulong playerId, uint id, int timeLeft, bool sendUpdate = true); | bool API_SetSharedVitalTimeLeft(uint id, int timeLeft, bool sendUpdate = true); | | bool API_SetVitalExpiry(BasePlayer player, uint id, float expiry, bool restart = true); | bool API_SetVitalExpiry(ulong playerId, uint id, float expiry, bool restart = true); | bool API_SetSharedVitalExpiry(uint id, float expiry, bool restart = true); | |-------------------------------------------------------------------------- | REMOVE: | bool API_RemoveVital(BasePlayer player, uint id, bool sendUpdate = true); | bool API_RemoveVital(ulong playerId, uint id, bool sendUpdate = true); | bool API_RemoveSharedVital(uint id, bool sendUpdate = true); | |-------------------------------------------------------------------------- | CLEAR: | void API_ClearVitals(BasePlayer player, bool sendUpdate = true); | void API_ClearPlayerVitals(BasePlayer player, bool sendUpdate = true); | void API_ClearPlayerVitals(ulong playerId, bool sendUpdate = true); | void API_ClearSharedVitals(bool sendUpdate = true); | |-------------------------------------------------------------------------- | SEND: | void API_SendVitals(BasePlayer player); | void API_SendVitals(ulong playerId); | void API_SendVitalsToEveryone(); | |-------------------------------------------------------------------------- | CHECK / INFO: | int API_GetSharedVitalCount(); | int API_GetPlayerVitalCount(BasePlayer player); | int API_GetPlayerVitalCount(ulong playerId); | int API_GetTotalPlayerVitalCount(BasePlayer player); | int API_GetTotalPlayerVitalCount(ulong playerId); | | bool API_HasVital(BasePlayer player, uint id); | bool API_HasVital(ulong playerId, uint id); | bool API_HasSharedVital(uint id); | | Dictionary<string, object> API_GetVitalInfo(BasePlayer player, uint id); | Dictionary<string, object> API_GetVitalInfo(ulong playerId, uint id); | Dictionary<string, object> API_GetSharedVitalInfo(uint id); | |-------------------------------------------------------------------------- | HOOKS: | object CanAddCustomVital(BasePlayer player, CustomVitalInfo vital, bool shared); | void OnCustomVitalAdded(BasePlayer player, uint id, bool shared, CustomVitalInfo info); | void OnCustomVitalUpdated(BasePlayer player, uint id, bool shared, CustomVitalInfo info); | void OnCustomVitalRemoved(BasePlayer player, uint id, bool shared); | void OnCustomVitalsCleared(BasePlayer player, bool shared); | void OnCustomVitalsSent(BasePlayer player, int count); | |-------------------------------------------------------------------------- | TimeLeft Formatting | - The {timeleft:} placeholder displays a countdown timer. With nothing after the colon, it defaults to hh:mm:ss format (e.g., 01:05:15). | | | INPUT OUTPUT | {timeleft:} 03:05:07 | {timeleft:hh\\:mm\\:ss} 03:05:07 | {timeleft:h\\:mm\\:ss} 3:05:07 | {timeleft:mm\\:ss} 05:07 | {timeleft:m\\:ss} 5:07 | {timeleft:ss} 07 | | MORE INFO https://carbonmod.gg/devs/features/custom-vitals-manager#timeleft-formatting | |-------------------------------------------------------------------------- Special thanks to CarbonMod https://carbonmod.gg/ Support