C#:
using Network;
using Newtonsoft.Json;
using Oxide.Core;
using Oxide.Core.Configuration;
using Oxide.Core.Libraries.Covalence;
using Oxide.Game.Rust.Cui;
using Rust;
using System.Collections.Generic;
using System.Linq;
using UnityEngine;
namespace Oxide.Plugins
{
[Info("Vanish", "Menevt", "1.6.6")]
[Description("Allows players with permission to become invisible")]
public class Vanish : CovalencePlugin
{
#region Configuration
private readonly List<BasePlayer> _hiddenPlayers = new List<BasePlayer>();
private List<ulong> _hiddenOffline = new List<ulong>();
private static readonly List<string> _registeredhooks = new List<string> { "CanUseLockedEntity", "OnPlayerDisconnected", "OnEntityTakeDamage" };
private static readonly DamageTypeList _EmptyDmgList = new DamageTypeList();
CuiElementContainer cachedVanishUI = null;
private Configuration config;
public class Configuration
{
[JsonProperty("NoClip on Vanish (runs noclip command)")]
public bool NoClipOnVanish = true;
[JsonProperty("Use OnEntityTakeDamage hook (Set to true to enable use of vanish.damage perm.Set to false for better performance)")]
public bool UseOnEntityTakeDamage = false;
[JsonProperty("Use CanUseLockedEntity hook (Allows vanished players with the perm vanish.unlock to bypass locks.Set to false for better performance)")]
public bool UseCanUseLockedEntity = true;
[JsonProperty("Keep a vanished player hidden on disconnect")]
public bool HideOnDisconnect = true;
[JsonProperty("Turn off fly hack detection for players in vanish")]
public bool AntiHack = true;
[JsonProperty("Disable metabolism in vanish")]
public bool Metabolism = true;
[JsonProperty("Reset hydration and health on un-vanishing (resets to pre-vanished state)")]
public bool MetabolismReset = true;
[JsonProperty("Enable vanishing and reappearing sound effects")]
public bool EnableSound = true;
[JsonProperty("Make sound effects public")]
public bool PublicSound = false;
[JsonProperty("Enable chat notifications")]
public bool EnableNotifications = true;
[JsonProperty("Sound effect to use when vanishing")]
public string VanishSoundEffect = "assets/prefabs/npc/patrol helicopter/effects/rocket_fire.prefab";
[JsonProperty("Sound effect to use when reappearing")]
public string ReappearSoundEffect = "assets/prefabs/npc/patrol helicopter/effects/rocket_fire.prefab";
[JsonProperty("Enable GUI")]
public bool EnableGUI = true;
[JsonProperty("Icon URL (.png or.jpg)")]
public string ImageUrlIcon = "http://i.imgur.com/Gr5G3YI.png";
[JsonProperty("Image Color")]
public string ImageColor = "1 1 1 0.3";
[JsonProperty("Image AnchorMin")]
public string ImageAnchorMin = "0.175 0.017";
[JsonProperty("Image AnchorMax")]
public string ImageAnchorMax = "0.22 0.08";
public string ToJson() => JsonConvert.SerializeObject(this);
public Dictionary<string, object> ToDictionary() => JsonConvert.DeserializeObject<Dictionary<string, object>>(ToJson());
}
protected override void LoadDefaultConfig() => config = new Configuration();
protected override void LoadConfig()
{
base.LoadConfig();
try
{
config = Config.ReadObject<Configuration>();
if (config == null)
{
throw new JsonException();
}
if (!config.ToDictionary().Keys.SequenceEqual(Config.ToDictionary(x => x.Key, x => x.Value).Keys))
{
LogWarning("Configuration appears to be outdated; updating and saving");
SaveConfig();
}
}
catch
{
LogWarning($"Configuration file {Name}.json is invalid; using defaults");
LoadDefaultConfig();
}
}
protected override void SaveConfig()
{
LogWarning($"Configuration changes saved to {Name}.json");
Config.WriteObject(config, true);
}
private void Loaded()
{
_hiddenOfflineData = Interface.Oxide.DataFileSystem.GetFile("VanishPlayers");
LoadData();
}
#endregion Configuration
#region Localization
protected override void LoadDefaultMessages()
{
lang.RegisterMessages(new Dictionary<string, string>
{
["VanishCommand"] = "vanish",
["Vanished"] = "Vanish: <color=orange> Enabled </color>",
["Reappear"] = "Vanish: <color=orange> Disabled </color>",
["NoPerms"] = "You do not have permission to do this",
["PermanentVanish"] = "You are in a permanent vanish mode",
}, this);
}
#endregion Localization
#region Initialization
private const string PermAllow = "vanish.allow";
private const string PermUnlock = "vanish.unlock";
private const string PermDamage = "vanish.damage";
private const string PermVanish = "vanish.permanent";
private void Init()
{
cachedVanishUI = CreateVanishUI();
// Register universal chat/console commands
AddLocalizedCommand(nameof(VanishCommand));
// Register permissions for commands
permission.RegisterPermission(PermAllow, this);
permission.RegisterPermission(PermUnlock, this);
permission.RegisterPermission(PermDamage, this);
permission.RegisterPermission(PermVanish, this);
//Unsubscribe from hooks
UnSubscribeFromHooks();
if (!config.UseOnEntityTakeDamage)
{
_registeredhooks.Remove("OnEntityTakeDamage");
}
if (!config.UseCanUseLockedEntity)
{
_registeredhooks.Remove("CanUseLockedEntity");
}
foreach (var player in BasePlayer.activePlayerList)
{
if (!HasPerm(player.UserIDString, PermVanish) || IsInvisible(player)) continue;
Disappear(player);
}
foreach (var playerid in _hiddenOffline)
{
BasePlayer player = BasePlayer.FindByID(playerid);
if (player == null) continue;
if (IsInvisible(player))
continue;
if (!player.IsConnected)
{
var connections = Net.sv.connections.Where(con => con.connected && con.isAuthenticated && con.player is BasePlayer && con.player != player).ToList();
player.OnNetworkSubscribersLeave(connections);
player.DisablePlayerCollider();
player.syncPosition = false;
player.limitNetworking = true;
}
else
{
Disappear(player);
}
}
}
private void Unload()
{
foreach (var p in _hiddenPlayers)
{
if (!_hiddenOffline.Contains(p.userID))
_hiddenOffline.Add(p.userID);
}
//_hiddenOffline.AddRange(_hiddenPlayers);
SaveData();
foreach (var playerid in _hiddenOffline.ToList())
{
BasePlayer player = BasePlayer.FindByID(playerid);
if (player == null) continue;
Reappear(player);
}
}
private DynamicConfigFile _hiddenOfflineData;
private void LoadData()
{
try
{
_hiddenOffline = _hiddenOfflineData.ReadObject<List<ulong>>();
}
catch
{
_hiddenOffline = new List<ulong>();
}
}
private void SaveData()
{
_hiddenOfflineData.WriteObject(_hiddenOffline);
}
#endregion Initialization
#region Commands
private void VanishCommand(IPlayer iplayer, string command, string[] args)
{
BasePlayer player = (BasePlayer)iplayer.Object;
if (player == null) return;
if (!HasPerm(player.UserIDString, PermAllow))
{
if (config.EnableNotifications) Message(player.IPlayer, "NoPerms");
return;
}
if (HasPerm(player.UserIDString, PermVanish))
{
if (config.EnableNotifications) Message(player.IPlayer, "PermanentVanish");
return;
}
if (IsInvisible(player)) Reappear(player);
else Disappear(player);
}
private void Reappear(BasePlayer player)
{
if (Interface.CallHook("OnVanishReappear", player) != null) return;
if (config.AntiHack) player.ResetAntiHack();
player.syncPosition = true;
VanishPositionUpdate vanishPositionUpdate;
if (player.TryGetComponent<VanishPositionUpdate>(out vanishPositionUpdate))
UnityEngine.Object.Destroy(vanishPositionUpdate);
//metabolism
if (config.Metabolism)
{
player.metabolism.temperature.min = -100;
player.metabolism.temperature.max = 100;
player.metabolism.radiation_poison.max = 500;
player.metabolism.oxygen.min = 0;
player.metabolism.calories.min = 0;
player.metabolism.wetness.max = 1;
}
if (config.MetabolismReset)
{
MetabolismValues value;
if (_storedMetabolism.TryGetValue(player, out value))
{
player.health = value.health;
player.metabolism.hydration.value = value.hydration;
}
_storedMetabolism.Remove(player);
}
player.metabolism.isDirty = true;
player.metabolism.SendChangesToClient();
player._limitedNetworking = false;
_hiddenPlayers.Remove(player);
player.EnablePlayerCollider();
player.UpdateNetworkGroup();
player.SendNetworkUpdate();
player.GetHeldEntity()?.SendNetworkUpdate();
//Un-Mute Player Effects
player.drownEffect.guid = "28ad47c8e6d313742a7a2740674a25b5";
player.fallDamageEffect.guid = "ca14ed027d5924003b1c5d9e523a5fce";
if (_hiddenPlayers.Count == 0) UnSubscribeFromHooks();
if (config.EnableSound)
{
if (config.PublicSound)
{
Effect.server.Run(config.ReappearSoundEffect, player.transform.position);
}
else
{
SendEffect(player, config.ReappearSoundEffect);
}
}
CuiHelper.DestroyUi(player, "VanishUI");
if (config.NoClipOnVanish && player.IsFlying) player.SendConsoleCommand("noclip");
if (config.EnableNotifications) Message(player.IPlayer, "Reappear");
}
private class MetabolismValues
{
public float health;
public float hydration;
}
private Dictionary<BasePlayer, MetabolismValues> _storedMetabolism = new Dictionary<BasePlayer, MetabolismValues>();
private void Disappear(BasePlayer player)
{
if (!_hiddenPlayers.Contains(player))
_hiddenPlayers.Add(player);
if (Interface.CallHook("OnVanishDisappear", player) != null) return;
if (config.AntiHack)
player.PauseFlyHackDetection(float.MaxValue);
VanishPositionUpdate vanishPositionUpdate;
if (player.TryGetComponent<VanishPositionUpdate>(out vanishPositionUpdate))
UnityEngine.Object.Destroy(vanishPositionUpdate);
player.gameObject.AddComponent<VanishPositionUpdate>();
//metabolism
if (config.Metabolism)
{
player.metabolism.temperature.min = 20;
player.metabolism.temperature.max = 20;
player.metabolism.radiation_poison.max = 0;
player.metabolism.oxygen.min = 1;
player.metabolism.wetness.max = 0;
player.metabolism.calories.min = player.metabolism.calories.value;
player.metabolism.isDirty = true;
player.metabolism.SendChangesToClient();
}
if (config.MetabolismReset && !player._limitedNetworking)
_storedMetabolism[player] = new MetabolismValues() { health = player.health, hydration = player.metabolism.hydration.value };
var connections = Net.sv.connections.Where(con => con.connected && con.isAuthenticated && con.player is BasePlayer && con.player != player).ToList();
player.OnNetworkSubscribersLeave(connections);
player.DisablePlayerCollider();
player.syncPosition = false;
player._limitedNetworking = true;
//Mute Player Effects
player.fallDamageEffect = new GameObjectRef();
player.drownEffect = new GameObjectRef();
if (_hiddenPlayers.Count == 1) SubscribeToHooks();
if (config.EnableSound)
{
if (config.PublicSound)
{
Effect.server.Run(config.VanishSoundEffect, player.transform.position);
}
else
{
SendEffect(player, config.VanishSoundEffect);
}
}
if (config.NoClipOnVanish && !player.IsFlying && !player.isMounted) player.SendConsoleCommand("noclip");
if (config.EnableGUI)
{
CuiHelper.AddUi(player, cachedVanishUI);
}
if (config.EnableNotifications) Message(player.IPlayer, "Vanished");
}
#endregion Commands
#region Hooks
private void OnPlayerConnected(BasePlayer player)
{
if (_hiddenOffline.Contains(player.userID))
{
_hiddenOffline.Remove(player.userID);
if (HasPerm(player.UserIDString, PermAllow))
Disappear(player);
return;
}
if (HasPerm(player.UserIDString, PermVanish))
{
Disappear(player);
}
}
private object CanUseLockedEntity(BasePlayer player, BaseLock baseLock)
{
if (!player.limitNetworking) return null;
if (HasPerm(player.UserIDString, PermUnlock)) return true;
if (config.EnableNotifications) Message(player.IPlayer, "NoPerms");
return null;
}
private object OnEntityTakeDamage(BaseCombatEntity entity, HitInfo info)
{
BasePlayer attacker = info?.InitiatorPlayer;
BasePlayer victim = entity?.ToPlayer();
if (!IsInvisible(victim) && !IsInvisible(attacker)) return null;
if (attacker == null) return null;
if (IsInvisible(attacker) && HasPerm(attacker.UserIDString, PermDamage)) return null;
info.damageTypes = _EmptyDmgList;
info.HitMaterial = 0;
info.PointStart = Vector3.zero;
info.HitEntity = null;
return true;
}
private void OnPlayerDisconnected(BasePlayer player, string reason)
{
if (!IsInvisible(player)) return;
if (!config.HideOnDisconnect && !HasPerm(player.UserIDString, PermVanish))
Reappear(player);
else
{
float terrainY = TerrainMeta.HeightMap.GetHeight(player.transform.position);
if (player.transform.position.y > terrainY)
player.transform.position = new Vector3(player.transform.position.x, terrainY, player.transform.position.z);
if (!_hiddenOffline.Contains(player.userID))
_hiddenOffline.Add(player.userID);
_hiddenPlayers.Remove(player);
VanishPositionUpdate t;
if (player.TryGetComponent<VanishPositionUpdate>(out t))
UnityEngine.Object.Destroy(t);
}
if (_hiddenPlayers.Count == 0) UnSubscribeFromHooks();
CuiHelper.DestroyUi(player, "VanishUI");
CuiHelper.DestroyUi(player, "VanishColliderUI");
}
private void OnPlayerSpectate(BasePlayer player, string spectateFilter)
{
VanishPositionUpdate vanishPositionUpdate;
if (!player.TryGetComponent<VanishPositionUpdate>(out vanishPositionUpdate)) return;
vanishPositionUpdate.DestroyChildGO();
}
private object OnPlayerSpectateEnd(BasePlayer player, string spectateFilter)
{
VanishPositionUpdate vanishPositionUpdate;
if (!player.TryGetComponent<VanishPositionUpdate>(out vanishPositionUpdate)) return null;
player.SetParent(null, false, false);
player.SetPlayerFlag(BasePlayer.PlayerFlags.Spectating, false);
vanishPositionUpdate.CreateChildGO();
player.gameObject.layer = 17;
return true;
}
private object OnPlayerColliderEnable(BasePlayer player, CapsuleCollider collider) => IsInvisible(player) ? (object)true : null;
#endregion Hooks
#region GUI
private CuiElementContainer CreateVanishUI()
{
CuiElementContainer elements = new CuiElementContainer();
string panel = elements.Add(new CuiPanel
{
Image = { Color = "0.5 0.5 0.5 0.0" },
RectTransform = { AnchorMin = config.ImageAnchorMin, AnchorMax = config.ImageAnchorMax }
}, "Hud.Menu", "VanishUI");
elements.Add(new CuiElement
{
Parent = panel,
Components =
{
new CuiRawImageComponent {Color = config.ImageColor, Url = config.ImageUrlIcon},
new CuiRectTransformComponent {AnchorMin = "0 0", AnchorMax = "1 1"}
}
});
return elements;
}
#endregion GUI
#region Monobehaviour
public class VanishPositionUpdate : FacepunchBehaviour
{
private BasePlayer player;
GameObject child;
SphereCollider col;
int LayerReserved1 = (int)Layer.Reserved1;
private void Awake()
{
player = GetComponent<BasePlayer>();
player.transform.localScale = Vector3.zero;
BaseEntity.Query.Server.RemovePlayer(player);
CreateChildGO();
}
private void UpdatePos()
{
using (TimeWarning.New("UpdateVanishGroup"))
player.net.UpdateGroups(player.transform.position);
}
void OnTriggerEnter(Collider col)
{
TriggerParent triggerParent = col.GetComponentInParent<TriggerParent>();
if (triggerParent != null)
{
triggerParent.OnEntityEnter(player);
return;
}
TriggerWorkbench triggerWorkbench = col.GetComponentInParent<TriggerWorkbench>();
if (triggerWorkbench != null)
{
player.EnterTrigger(triggerWorkbench);
player.nextCheckTime = float.MaxValue;
player.cachedCraftLevel = triggerWorkbench.parentBench.Workbenchlevel;
player.SetPlayerFlag(BasePlayer.PlayerFlags.Workbench1, player.cachedCraftLevel == 1f);
player.SetPlayerFlag(BasePlayer.PlayerFlags.Workbench2, player.cachedCraftLevel == 2f);
player.SetPlayerFlag(BasePlayer.PlayerFlags.Workbench3, player.cachedCraftLevel == 3f);
}
}
void OnTriggerExit(Collider col)
{
TriggerParent triggerParent = col.GetComponentInParent<TriggerParent>();
if (triggerParent != null)
{
triggerParent.OnEntityLeave(player);
return;
}
TriggerWorkbench triggerWorkbench = col.GetComponentInParent<TriggerWorkbench>();
if (triggerWorkbench != null)
{
player.LeaveTrigger(triggerWorkbench);
player.cachedCraftLevel = 0f;
player.SetPlayerFlag(BasePlayer.PlayerFlags.Workbench1, false);
player.SetPlayerFlag(BasePlayer.PlayerFlags.Workbench2, false);
player.SetPlayerFlag(BasePlayer.PlayerFlags.Workbench3, false);
player.nextCheckTime = Time.realtimeSinceStartup;
return;
}
}
public void CreateChildGO()
{
if (player.IsSpectating()) return;
player.transform.localScale = Vector3.zero;
child = gameObject.CreateChild();
col = child.AddComponent<SphereCollider>();
child.layer = LayerReserved1;
child.transform.localScale = Vector3.zero;
col.isTrigger = true;
player.lastAdminCheatTime = float.MaxValue;
InvokeRepeating("UpdatePos", 1f, 5f);
}
public void DestroyChildGO()
{
if (child == null) return;
if (player.triggers != null)
{
for (int i = player.triggers.Count - 1; i >= 0; i--)
{
if (player.triggers[i] is TriggerWorkbench)
{
player.triggers[i].OnEntityLeave(player);
player.triggers.RemoveAt(i);
}
}
}
if (col != null)
Destroy(col);
if (child != null)
Destroy(child);
CancelInvoke(UpdatePos);
}
private void OnDestroy()
{
player.Connection.active = true;
DestroyChildGO();
BaseEntity.Query.Server.AddPlayer(player);
player.lastAdminCheatTime = Time.realtimeSinceStartup;
player.transform.localScale = new Vector3(1, 1, 1);
//Rest Workbench Level
player.cachedCraftLevel = 0f;
player.SetPlayerFlag(BasePlayer.PlayerFlags.Workbench1, false);
player.SetPlayerFlag(BasePlayer.PlayerFlags.Workbench2, false);
player.SetPlayerFlag(BasePlayer.PlayerFlags.Workbench3, false);
player.nextCheckTime = Time.realtimeSinceStartup;
player = null;
}
}
#endregion Monobehaviour
#region Helpers
private void AddLocalizedCommand(string command)
{
foreach (string language in lang.GetLanguages(this))
{
Dictionary<string, string> messages = lang.GetMessages(language, this);
foreach (KeyValuePair<string, string> message in messages)
{
if (!message.Key.Equals(command)) continue;
if (string.IsNullOrEmpty(message.Value)) continue;
AddCovalenceCommand(message.Value, command);
}
}
}
private bool HasPerm(string id, string perm) => permission.UserHasPermission(id, perm);
private string GetLang(string langKey, string playerId = null, params object[] args) => string.Format(lang.GetMessage(langKey, this, playerId), args);
private void Message(IPlayer player, string langKey, params object[] args)
{
if (player.IsConnected) player.Message(GetLang(langKey, player.Id, args));
}
private bool IsInvisible(BasePlayer player) => player?._limitedNetworking ?? false;
private void UnSubscribeFromHooks()
{
foreach (var hook in _registeredhooks)
Unsubscribe(hook);
}
private void SubscribeToHooks()
{
foreach (var hook in _registeredhooks)
Subscribe(hook);
}
private static void SendEffect(BasePlayer player, string sound) => EffectNetwork.Send(new Effect(sound, player, 0, Vector3.zero, Vector3.forward), player.net.connection);
#endregion Helpers
#region Public Helpers
public void _Disappear(BasePlayer basePlayer) => Disappear(basePlayer);
public void _Reappear(BasePlayer basePlayer) => Reappear(basePlayer);
public bool _IsInvisible(BasePlayer basePlayer) => IsInvisible(basePlayer);
#endregion
}
}