Class ReflectionField

Class that represents a reflectable script field.

Hierarchy (View Summary)

ReflectionMember
- ReflectionField

Index

Constructors

Properties

declaringType name

Methods

getAllAttributes getAttribute getAttributes getValue hasAttribute isStatic setValue

Constructors

constructor

new ReflectionField(
    type: Type,
    name: string,
    isStatic: boolean,
): ReflectionField
Parameters
- type: Type
- name: string
- isStatic: boolean
Returns ReflectionField

Overrides ReflectionMember.constructor

Properties

`Readonly`declaringType

declaringType: Type

The class that declares this member.

`Readonly`name

name: string

The name of given type.

Methods

getAllAttributes

getAllAttributes(): Attribute[]

Retrieves all custom attributes defined on this member.

Returns Attribute[]
All custom attributes defined on this member

Inherited from ReflectionMember.getAllAttributes

getAttribute

getAttribute<T extends Attribute>(attributeType: ClassOf<T>): T
Retrieves a custom attribute of a specified type that is applied to a specified member.
Type Parameters
- T extends Attribute
Parameters
- attributeType: ClassOf<T>
  The type of attribute to search for. Only attributes that are assignable to this type are returned.
Returns T
A custom attribute that matches T, or null if no such attribute is found.

Inherited from ReflectionMember.getAttribute

getAttributes

getAttributes<T extends Attribute>(attributeType: ClassOf<T>): T[]
Retrieves custom attributes of a specified type that is applied to this member.
Type Parameters
- T extends Attribute
Parameters
- attributeType: ClassOf<T>
  The type of attribute to search for. Only attributes that are assignable to this type are returned.
Returns T[]
Custom attributes that matche T

Inherited from ReflectionMember.getAttributes

getValue

getValue(instance: any): any
Sets value of this field to given value.
Parameters
- instance: any
  The object whose value will be get.
Returns any
Current field value.

hasAttribute

hasAttribute(attributeType: ClassOf<Attribute>): boolean
Checks whether the member has the given attribute type.
Parameters
- attributeType: ClassOf<Attribute>
  The type of attribute to search for.
Returns boolean
True if the attribute exists on the member.

Inherited from ReflectionMember.hasAttribute

isStatic

isStatic(): boolean

Checks if this field is static.

Returns boolean
Whether this method is static.

Overrides ReflectionMember.isStatic

setValue

setValue(instance: any, value: any): void
Sets value of this field to given value.
Parameters
- instance: any
  The object whose value will be set.
- value: any
  The new field value.
Returns void