Struct UnturnedUIEffectKey

Effect key wrapper struct that is used in OpenMod.Unturned effect APIs

Implements
IComparable<UnturnedUIEffectKey>
Namespace: OpenMod.Unturned.Effects
Assembly: OpenMod.Unturned.dll
Syntax
public struct UnturnedUIEffectKey : IEquatable<UnturnedUIEffectKey>, IComparable<UnturnedUIEffectKey>

Constructors

| Improve this Doc View Source

UnturnedUIEffectKey(Int16)

Declaration
public UnturnedUIEffectKey(short value)
Parameters
Type Name Description
System.Int16 value

Fields

| Improve this Doc View Source

Invalid

Invalid effect key with value of -1. Sending -1 to client will launch effect as one shot and not register the key.

Declaration
public static readonly UnturnedUIEffectKey Invalid
Field Value
Type Description
UnturnedUIEffectKey
| Improve this Doc View Source

Value

The value of the effect key

Declaration
public readonly short Value
Field Value
Type Description
System.Int16

Properties

| Improve this Doc View Source

IsValid

Checks if this effect key is valid

Declaration
public bool IsValid { get; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

CompareTo(UnturnedUIEffectKey)

Declaration
public int CompareTo(UnturnedUIEffectKey other)
Parameters
Type Name Description
UnturnedUIEffectKey other
Returns
Type Description
System.Int32
| Improve this Doc View Source

Equals(UnturnedUIEffectKey)

Declaration
public bool Equals(UnturnedUIEffectKey other)
Parameters
Type Name Description
UnturnedUIEffectKey other
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Equals(Nullable<Object>)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
System.Nullable<System.Object> obj
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

Operators

| Improve this Doc View Source

Equality(UnturnedUIEffectKey, UnturnedUIEffectKey)

Declaration
public static bool operator ==(UnturnedUIEffectKey left, UnturnedUIEffectKey right)
Parameters
Type Name Description
UnturnedUIEffectKey left
UnturnedUIEffectKey right
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Explicit(UnturnedUIEffectKey to Int16)

Declaration
public static explicit operator short (UnturnedUIEffectKey key)
Parameters
Type Name Description
UnturnedUIEffectKey key
Returns
Type Description
System.Int16
| Improve this Doc View Source

Explicit(Int16 to UnturnedUIEffectKey)

Declaration
public static explicit operator UnturnedUIEffectKey(short value)
Parameters
Type Name Description
System.Int16 value
Returns
Type Description
UnturnedUIEffectKey
| Improve this Doc View Source

Inequality(UnturnedUIEffectKey, UnturnedUIEffectKey)

Declaration
public static bool operator !=(UnturnedUIEffectKey left, UnturnedUIEffectKey right)
Parameters
Type Name Description
UnturnedUIEffectKey left
UnturnedUIEffectKey right
Returns
Type Description
System.Boolean

Implements

IEquatable<>
IComparable<>