NetworkValue
Struct · Namespace OMX.ModAPI · Assembly OMX.ModAPI.Shared.dll
public readonly struct NetworkValue : IEquatable<NetworkValue>Implements: IEquatable<NetworkValue>
Fields
Section titled “Fields”MaxBytesLength
Section titled “MaxBytesLength”public const int MaxBytesLength = 4096;MaxStringLength
Section titled “MaxStringLength”public const int MaxStringLength = 4096;Properties
Section titled “Properties”public NetworkValueKind Kind { get; }public static NetworkValue Null { get; }public object? Value { get; }The value as a plain object (bool, long, double, string, byte[] copy or null), for scripts.
Methods
Section titled “Methods”Equals
Section titled “Equals”public bool Equals(NetworkValue other);Parameters
otherNetworkValue
Returns bool
public override bool Equals(object? obj);Parameters
objobject?
Returns bool
public static NetworkValue From(bool value);Parameters
valuebool
Returns NetworkValue
public static NetworkValue From(long value);Parameters
valuelong
Returns NetworkValue
public static NetworkValue From(double value);Parameters
valuedouble
Returns NetworkValue
public static NetworkValue From(string value);Parameters
valuestring
Returns NetworkValue
public static NetworkValue From(ReadOnlySpan<byte> value);Parameters
valueReadOnlySpan<byte>
Returns NetworkValue
FromObject
Section titled “FromObject”public static NetworkValue FromObject(object? value);Converts a plain value: null, bool, any integer type, float/double, string or byte[]. This is the entry point for script languages, whose numbers arrive as double or int.
Parameters
valueobject?
Returns NetworkValue
GetHashCode
Section titled “GetHashCode”public override int GetHashCode();Returns int
ToString
Section titled “ToString”public override string ToString();Returns string
TryGetBoolean
Section titled “TryGetBoolean”public bool TryGetBoolean(out bool value);Parameters
valuebool
Returns bool
TryGetBytes
Section titled “TryGetBytes”public bool TryGetBytes(out ReadOnlyMemory<byte> value);Parameters
valueReadOnlyMemory<byte>
Returns bool
TryGetDouble
Section titled “TryGetDouble”public bool TryGetDouble(out double value);Parameters
valuedouble
Returns bool
TryGetInt64
Section titled “TryGetInt64”public bool TryGetInt64(out long value);Parameters
valuelong
Returns bool
TryGetString
Section titled “TryGetString”public bool TryGetString(out string value);Parameters
valuestring
Returns bool