About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class Encoding

Represents a character encoding.

Hierarchy (View Summary)

System.Object
- Encoding

Index

Accessors

ASCII BigEndianUnicode UTF32 UTF8

Methods

Cast Equals GetHashCode GetString ToString TryCast Equals

Accessors

`Static`ASCII

get ASCII(): Encoding
Gets an encoding for the ASCII (7-bit) character set.

Returns Encoding
An encoding for the ASCII (7-bit) character set.

`Static`BigEndianUnicode

get BigEndianUnicode(): Encoding
Gets an encoding for the UTF-16 format that uses the big endian byte order.

Returns Encoding
An encoding object for the UTF-16 format that uses the big endian byte order.

`Static`UTF32

get UTF32(): Encoding
Gets an encoding for the UTF-32 format using the little endian byte order.

Returns Encoding
An encoding object for the UTF-32 format using the little endian byte order.

`Static`UTF8

get UTF8(): Encoding
Gets an encoding for the UTF-8 format.

Returns Encoding
An encoding for the UTF-8 format.

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

GetString

GetString(
    bytes: TypedArray<number> | TypedArray<Byte>,
    index: number | Int32,
    count: number | Int32,
): string
When overridden in a derived class, decodes a sequence of bytes from the specified byte array into a string.
Parameters
- bytes: TypedArray<number> | TypedArray<Byte>
  The byte array containing the sequence of bytes to decode.
- index: number | Int32
  The index of the first byte to decode.
- count: number | Int32
  The number of bytes to decode.
Returns string
A string that contains the results of decoding the specified sequence of bytes.

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from Object.Equals