Struct FixedPoint2

Represents a quantity of something, to a precision of 0.01. To enforce this level of precision, floats are shifted by 2 decimal points, rounded, and converted to an int.

Implements
Robust.Shared.Serialization.ISelfSerialize
IComparable<FixedPoint2>
IEquatable<FixedPoint2>
IFormattable
Namespace: Content.Shared.FixedPoint
Assembly: Content.Shared.dll
Syntax
public struct FixedPoint2 : ISelfSerialize, IComparable<FixedPoint2>, IEquatable<FixedPoint2>, IFormattable

Properties

| Improve this Doc View Source

Epsilon

Declaration
public static FixedPoint2 Epsilon { get; }
Property Value
Type Description
FixedPoint2
| Improve this Doc View Source

MaxValue

Declaration
public static FixedPoint2 MaxValue { get; }
Property Value
Type Description
FixedPoint2
| Improve this Doc View Source

Value

Declaration
public int Value { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Zero

Declaration
public static FixedPoint2 Zero { get; }
Property Value
Type Description
FixedPoint2

Methods

| Improve this Doc View Source

Abs(FixedPoint2)

Declaration
public static FixedPoint2 Abs(FixedPoint2 a)
Parameters
Type Name Description
FixedPoint2 a
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

Clamp(FixedPoint2, FixedPoint2, FixedPoint2)

Declaration
public static FixedPoint2 Clamp(FixedPoint2 reagent, FixedPoint2 min, FixedPoint2 max)
Parameters
Type Name Description
FixedPoint2 reagent
FixedPoint2 min
FixedPoint2 max
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

CompareTo(FixedPoint2)

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

Deserialize(String)

Declaration
public void Deserialize(string value)
Parameters
Type Name Description
System.String value
| Improve this Doc View Source

Dist(FixedPoint2, FixedPoint2)

Declaration
public static FixedPoint2 Dist(FixedPoint2 a, FixedPoint2 b)
Parameters
Type Name Description
FixedPoint2 a
FixedPoint2 b
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

Double()

Declaration
public double Double()
Returns
Type Description
System.Double
| Improve this Doc View Source

Equals(FixedPoint2)

Declaration
public bool Equals(FixedPoint2 other)
Parameters
Type Name Description
FixedPoint2 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

Float()

Declaration
public float Float()
Returns
Type Description
System.Single
| Improve this Doc View Source

FromCents(Int32)

Declaration
public static FixedPoint2 FromCents(int value)
Parameters
Type Name Description
System.Int32 value
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

GetHashCode()

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

Int()

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

Max(FixedPoint2, FixedPoint2)

Declaration
public static FixedPoint2 Max(FixedPoint2 a, FixedPoint2 b)
Parameters
Type Name Description
FixedPoint2 a
FixedPoint2 b
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

Min(FixedPoint2, FixedPoint2)

Declaration
public static FixedPoint2 Min(FixedPoint2 a, FixedPoint2 b)
Parameters
Type Name Description
FixedPoint2 a
FixedPoint2 b
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

Min(FixedPoint2[])

Declaration
public static FixedPoint2 Min(params FixedPoint2[] fixedPoints)
Parameters
Type Name Description
FixedPoint2[] fixedPoints
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

New(Double)

Declaration
public static FixedPoint2 New(double value)
Parameters
Type Name Description
System.Double value
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

New(Int32)

Declaration
public static FixedPoint2 New(int value)
Parameters
Type Name Description
System.Int32 value
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

New(Single)

Declaration
public static FixedPoint2 New(float value)
Parameters
Type Name Description
System.Single value
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

New(String)

Declaration
public static FixedPoint2 New(string value)
Parameters
Type Name Description
System.String value
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

NewCeiling(Single)

Create the closest FixedPoint2 for a float value, always rounding up.

Declaration
public static FixedPoint2 NewCeiling(float value)
Parameters
Type Name Description
System.Single value
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

Serialize()

Declaration
public string Serialize()
Returns
Type Description
System.String
| Improve this Doc View Source

Sign(FixedPoint2)

Declaration
public static int Sign(FixedPoint2 value)
Parameters
Type Name Description
FixedPoint2 value
Returns
Type Description
System.Int32
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
| Improve this Doc View Source

ToString(Nullable<String>, Nullable<IFormatProvider>)

Declaration
public string ToString(string? format, IFormatProvider? formatProvider)
Parameters
Type Name Description
System.Nullable<System.String> format
System.Nullable<IFormatProvider> formatProvider
Returns
Type Description
System.String

Operators

| Improve this Doc View Source

Addition(FixedPoint2, FixedPoint2)

Declaration
public static FixedPoint2 operator +(FixedPoint2 a, FixedPoint2 b)
Parameters
Type Name Description
FixedPoint2 a
FixedPoint2 b
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

Division(FixedPoint2, FixedPoint2)

Declaration
public static FixedPoint2 operator /(FixedPoint2 a, FixedPoint2 b)
Parameters
Type Name Description
FixedPoint2 a
FixedPoint2 b
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

Division(FixedPoint2, Single)

Declaration
public static FixedPoint2 operator /(FixedPoint2 a, float b)
Parameters
Type Name Description
FixedPoint2 a
System.Single b
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

Equality(FixedPoint2, FixedPoint2)

Declaration
public static bool operator ==(FixedPoint2 a, FixedPoint2 b)
Parameters
Type Name Description
FixedPoint2 a
FixedPoint2 b
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Equality(FixedPoint2, Int32)

Declaration
public static bool operator ==(FixedPoint2 a, int b)
Parameters
Type Name Description
FixedPoint2 a
System.Int32 b
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Explicit(FixedPoint2 to Double)

Declaration
public static explicit operator double (FixedPoint2 n)
Parameters
Type Name Description
FixedPoint2 n
Returns
Type Description
System.Double
| Improve this Doc View Source

Explicit(FixedPoint2 to Int32)

Declaration
public static explicit operator int (FixedPoint2 n)
Parameters
Type Name Description
FixedPoint2 n
Returns
Type Description
System.Int32
| Improve this Doc View Source

Explicit(FixedPoint2 to Single)

Declaration
public static explicit operator float (FixedPoint2 n)
Parameters
Type Name Description
FixedPoint2 n
Returns
Type Description
System.Single
| Improve this Doc View Source

GreaterThan(FixedPoint2, FixedPoint2)

Declaration
public static bool operator>(FixedPoint2 a, FixedPoint2 b)
Parameters
Type Name Description
FixedPoint2 a
FixedPoint2 b
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GreaterThan(FixedPoint2, Int32)

Declaration
public static bool operator>(FixedPoint2 a, int b)
Parameters
Type Name Description
FixedPoint2 a
System.Int32 b
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GreaterThanOrEqual(FixedPoint2, FixedPoint2)

Declaration
public static bool operator >=(FixedPoint2 a, FixedPoint2 b)
Parameters
Type Name Description
FixedPoint2 a
FixedPoint2 b
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GreaterThanOrEqual(FixedPoint2, Int32)

Declaration
public static bool operator >=(FixedPoint2 a, int b)
Parameters
Type Name Description
FixedPoint2 a
System.Int32 b
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Implicit(Double to FixedPoint2)

Declaration
public static implicit operator FixedPoint2(double n)
Parameters
Type Name Description
System.Double n
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

Implicit(Int32 to FixedPoint2)

Declaration
public static implicit operator FixedPoint2(int n)
Parameters
Type Name Description
System.Int32 n
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

Implicit(Single to FixedPoint2)

Declaration
public static implicit operator FixedPoint2(float n)
Parameters
Type Name Description
System.Single n
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

Inequality(FixedPoint2, FixedPoint2)

Declaration
public static bool operator !=(FixedPoint2 a, FixedPoint2 b)
Parameters
Type Name Description
FixedPoint2 a
FixedPoint2 b
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Inequality(FixedPoint2, Int32)

Declaration
public static bool operator !=(FixedPoint2 a, int b)
Parameters
Type Name Description
FixedPoint2 a
System.Int32 b
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LessThan(FixedPoint2, FixedPoint2)

Declaration
public static bool operator <(FixedPoint2 a, FixedPoint2 b)
Parameters
Type Name Description
FixedPoint2 a
FixedPoint2 b
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LessThan(FixedPoint2, Int32)

Declaration
public static bool operator <(FixedPoint2 a, int b)
Parameters
Type Name Description
FixedPoint2 a
System.Int32 b
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LessThanOrEqual(FixedPoint2, FixedPoint2)

Declaration
public static bool operator <=(FixedPoint2 a, FixedPoint2 b)
Parameters
Type Name Description
FixedPoint2 a
FixedPoint2 b
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LessThanOrEqual(FixedPoint2, Int32)

Declaration
public static bool operator <=(FixedPoint2 a, int b)
Parameters
Type Name Description
FixedPoint2 a
System.Int32 b
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Multiply(FixedPoint2, FixedPoint2)

Declaration
public static FixedPoint2 operator *(FixedPoint2 a, FixedPoint2 b)
Parameters
Type Name Description
FixedPoint2 a
FixedPoint2 b
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

Multiply(FixedPoint2, Double)

Declaration
public static FixedPoint2 operator *(FixedPoint2 a, double b)
Parameters
Type Name Description
FixedPoint2 a
System.Double b
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

Multiply(FixedPoint2, Int32)

Declaration
public static FixedPoint2 operator *(FixedPoint2 a, int b)
Parameters
Type Name Description
FixedPoint2 a
System.Int32 b
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

Multiply(FixedPoint2, Single)

Declaration
public static FixedPoint2 operator *(FixedPoint2 a, float b)
Parameters
Type Name Description
FixedPoint2 a
System.Single b
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

Subtraction(FixedPoint2, FixedPoint2)

Declaration
public static FixedPoint2 operator -(FixedPoint2 a, FixedPoint2 b)
Parameters
Type Name Description
FixedPoint2 a
FixedPoint2 b
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

UnaryNegation(FixedPoint2)

Declaration
public static FixedPoint2 operator -(FixedPoint2 a)
Parameters
Type Name Description
FixedPoint2 a
Returns
Type Description
FixedPoint2
| Improve this Doc View Source

UnaryPlus(FixedPoint2)

Declaration
public static FixedPoint2 operator +(FixedPoint2 a)
Parameters
Type Name Description
FixedPoint2 a
Returns
Type Description
FixedPoint2

Implements

Robust.Shared.Serialization.ISelfSerialize
IComparable<>
IEquatable<>
IFormattable