Class Class

Scaffold class.

Hierarchy (View Summary)

NativeStruct
- Class

Constructors

constructor

new Class(handleOrWrapper: NativePointerValue): Class
Parameters
- handleOrWrapper: NativePointerValue
Returns Class
Inherited from NativeStruct.constructor

Properties

`Readonly`handle

handle: NativePointer

Accessors

actualInstanceSize

get actualInstanceSize(): number
Gets the actual size of the instance of the current class.

Returns number

arrayClass

get arrayClass(): Class
Gets the array class which encompass the current class.

Returns Class

arrayElementSize

get arrayElementSize(): number
Gets the size of the object encompassed by the current array class.

Returns number

assemblyName

get assemblyName(): string
Gets the name of the assembly in which the current class is defined.

Returns string

baseType

get baseType(): Il2Cpp.Type
Gets the encompassed type of this array, reference, pointer or enum type.

Returns Il2Cpp.Type

declaringClass

get declaringClass(): Class
Gets the class that declares the current nested class.

Returns Class

elementClass

get elementClass(): Class
Gets the class of the object encompassed or referred to by the current array, pointer or reference class.

Returns Class

fields

get fields(): Il2Cpp.Field<Il2Cpp.Field.Type>[]
Gets the fields of the current class.

Returns Il2Cpp.Field<Il2Cpp.Field.Type>[]

flags

get flags(): number
Gets the flags of the current class.

Returns number

fullName

get fullName(): string
Gets the full name (namespace + name) of the current class.

Returns string

genericClass

get genericClass(): Class
Gets the generic class of the current class if the current class is inflated.

Returns Class

generics

get generics(): Class[]
Gets the generics parameters of this generic class.

Returns Class[]

hasReferences

get hasReferences(): boolean
Determines whether the GC has tracking references to the current class instances.

Returns boolean

hasStaticConstructor

get hasStaticConstructor(): boolean
Determines whether ther current class has a valid static constructor.

Returns boolean

image

get image(): Image
Gets the image in which the current class is defined.

Returns Image

instanceSize

get instanceSize(): number
Gets the size of the instance of the current class.

Returns number

interfaces

get interfaces(): Class[]
Gets the interfaces implemented or inherited by the current class.

Returns Class[]

isAbstract

get isAbstract(): boolean
Determines whether the current class is abstract.

Returns boolean

isBlittable

get isBlittable(): boolean
Determines whether the current class is blittable.

Returns boolean

isEnum

get isEnum(): boolean
Determines whether the current class is an enumeration.

Returns boolean

isGeneric

get isGeneric(): boolean
Determines whether the current class is a generic one.

Returns boolean

isInflated

get isInflated(): boolean
Determines whether the current class is inflated.

Returns boolean

isInterface

get isInterface(): boolean
Determines whether the current class is an interface.

Returns boolean

isStruct

get isStruct(): boolean
Determines whether the current class is a struct.

Returns boolean

isValueType

get isValueType(): boolean
Determines whether the current class is a value type.

Returns boolean

methods

get methods(): Il2Cpp.Method<ReturnType>[]
Gets the methods implemented by the current class.

Returns Il2Cpp.Method<ReturnType>[]

name

get name(): string
Gets the name of the current class.

Returns string

namespace

get namespace(): string
Gets the namespace of the current class.

Returns string

nestedClasses

get nestedClasses(): Class[]
Gets the classes nested inside the current class.

Returns Class[]

parent

get parent(): Class
Gets the class from which the current class directly inherits.

Returns Class

pointerClass

get pointerClass(): Class
Gets the pointer class of the current class.

Returns Class

rank

get rank(): number
Gets the rank (number of dimensions) of the current array class.

Returns number

staticFieldsData

get staticFieldsData(): NativePointer
Gets a pointer to the static fields of the current class.

Returns NativePointer

type

get type(): Il2Cpp.Type
Gets the type of the current class.

Returns Il2Cpp.Type

valueTypeSize

get valueTypeSize(): number
Gets the size of the instance - as a value type - of the current class.

Returns number

Methods

alloc

alloc(): Il2Cpp.Object
Allocates a new object of the current class.

Returns Il2Cpp.Object

asNullable

asNullable(): Class
Returns Class
Inherited from NativeStruct.asNullable

`Static`enumerate

enumerate(block: (klass: Class) => void): void
Executes a callback for every defined class.
Parameters
- block: (klass: Class) => void
Returns void

equals

equals(other: NativeStruct): boolean
Parameters
- other: NativeStruct
Returns boolean
Inherited from NativeStruct.equals

field

field<T extends Il2Cpp.Field.Type>(name: string): Il2Cpp.Field<T>
Gets the field identified by the given name.
Type Parameters
- T extends Il2Cpp.Field.Type
Parameters
- name: string
Returns Il2Cpp.Field<T>

hierarchy

hierarchy(options?: { includeCurrent?: boolean }): Generator<Class>
Gets the hierarchy of the current class.
Parameters
- Optionaloptions: { includeCurrent?: boolean }
Returns Generator<Class>

inflate

inflate(...classes: Class[]): Class
Builds a generic instance of the current generic class.
Parameters
- ...classes: Class[]
Returns Class

initialize

initialize(): Class
Calls the static constructor of the current class.

Returns Class

isAssignableFrom

isAssignableFrom(other: Class): boolean
Determines whether an instance of other class can be assigned to a variable of the current type.
Parameters
- other: Class
Returns boolean

isNull

isNull(): boolean
Returns boolean
Inherited from NativeStruct.isNull

isSubclassOf

isSubclassOf(other: Class, checkInterfaces: boolean): boolean
Determines whether the current class derives from other class.
Parameters
- other: Class
- checkInterfaces: boolean
Returns boolean

method

method<T extends ReturnType>(
name: string,
parameterCount?: number,
): Il2Cpp.Method<T>
Gets the method identified by the given name and parameter count.
Type Parameters
- T extends ReturnType
Parameters
- name: string
- OptionalparameterCount: number
Returns Il2Cpp.Method<T>

nested

nested(name: string): Class
Gets the nested class with the given name.
Parameters
- name: string
Returns Class

new

new(): Il2Cpp.Object
Allocates a new object of the current class and calls its default constructor.

Returns Il2Cpp.Object

toString

toString(): string
Returns string

tryField

tryField<T extends Il2Cpp.Field.Type>(name: string): Il2Cpp.Field<T>
Gets the field with the given name.
Type Parameters
- T extends Il2Cpp.Field.Type
Parameters
- name: string
Returns Il2Cpp.Field<T>

tryMethod

tryMethod<T extends ReturnType>(
name: string,
parameterCount?: number,
): Il2Cpp.Method<T>
Gets the method with the given name and parameter count.
Type Parameters
- T extends ReturnType
Parameters
- name: string
- OptionalparameterCount: number
Returns Il2Cpp.Method<T>

tryNested

tryNested(name: string): Class
Gets the nested class with the given name.
Parameters
- name: string
Returns Class