Interface IScriptMemberInfo

Interface for custom scripting languages type object with metadata.

Namespace: FlaxEditor.Scripting
Assembly: FlaxEngine.CSharp.dll
Syntax
public interface IScriptMemberInfo

Properties

DeclaringType

Gets the type that declares this member.

Declaration
ScriptType DeclaringType { get; }
Property Value
FlaxEditor.Scripting.ScriptType

HasGet

Gets a value indicating whether this member value can be gathered (via getter method or directly from the field).

Declaration
bool HasGet { get; }
Property Value
System.Boolean

HasSet

Gets a value indicating whether this member value can be set (via setter method or directly to the field).

Declaration
bool HasSet { get; }
Property Value
System.Boolean

IsAbstract

Gets a value indicating whether this method is declared as abstract (has to be overriden).

Declaration
bool IsAbstract { get; }
Property Value
System.Boolean

IsEvent

Gets a value indicating whether this member is an event.

Declaration
bool IsEvent { get; }
Property Value
System.Boolean

IsField

Gets a value indicating whether this member is a field.

Declaration
bool IsField { get; }
Property Value
System.Boolean

IsGeneric

Gets a value indicating whether this method is declared as generic (needs to be inflated with type arguments).

Declaration
bool IsGeneric { get; }
Property Value
System.Boolean

IsMethod

Gets a value indicating whether this member is a method.

Declaration
bool IsMethod { get; }
Property Value
System.Boolean

IsProperty

Gets a value indicating whether this member is a property.

Declaration
bool IsProperty { get; }
Property Value
System.Boolean

IsPublic

Gets a value indicating whether the type is declared public.

Declaration
bool IsPublic { get; }
Property Value
System.Boolean

IsStatic

Gets a value indicating whether the type is declared in static scope.

Declaration
bool IsStatic { get; }
Property Value
System.Boolean

IsVirtual

Gets a value indicating whether this method is declared as virtual (can be overriden).

Declaration
bool IsVirtual { get; }
Property Value
System.Boolean

MetadataToken

Gets a metadata token for sorting so it may not be the actual token.

Declaration
int MetadataToken { get; }
Property Value
System.Int32

Name

Gets a member name (eg. name of the field or method without leading class name nor namespace prefixes).

Declaration
string Name { get; }
Property Value
System.String

ParametersCount

Gets the method parameters count (valid for methods only).

Declaration
int ParametersCount { get; }
Property Value
System.Int32

ValueType

Gets the type of the value (field type, property type or method return value).

Declaration
ScriptType ValueType { get; }
Property Value
FlaxEditor.Scripting.ScriptType

Methods

GetAttributes(Boolean)

When overridden in a derived class, returns an array of all custom attributes applied to this member.

Declaration
object[] GetAttributes(bool inherit)
Parameters
System.Boolean inherit

true to search this member's inheritance chain to find the attributes; otherwise, false.
Returns
System.Object[]

An array that contains all the custom attributes applied to this member, or an array with zero elements if no attributes are defined.

GetParameters()

Gets the method parameters metadata (or event delegate signature parameters).

Declaration
ScriptMemberInfo.Parameter[] GetParameters()
Returns
FlaxEditor.Scripting.ScriptMemberInfo.Parameter[]

GetValue(Object)

Returns the member value of a specified object.

Declaration
object GetValue(object obj)
Parameters
System.Object obj

The object whose member value will be returned.
Returns
System.Object

The member value of the specified object.

HasAttribute(Type, Boolean)

Determines whether the specified attribute was defined for this member.

Declaration
bool HasAttribute(Type attributeType, bool inherit)
Parameters
System.Type attributeType

The attribute type.
System.Boolean inherit

true to search this member's inheritance chain to find the attributes; otherwise, false.
Returns
System.Boolean

true if the specified member has attribute; otherwise, false.

Invoke(Object, Object[])

Invokes the method on a specific object (null if static) using the provided parameters.

Declaration
object Invoke(object obj, object[] parameters)
Parameters
System.Object obj

The instance of the object to invoke its method. Use null for static methods.
System.Object[] parameters

List of parameters to provide.
Returns
System.Object

The value returned by the method.

SetValue(Object, Object)

Sets the member value of a specified object.

Declaration
void SetValue(object obj, object value)
Parameters
System.Object obj

The object whose member value will be modified.
System.Object value

The new member value.

Extension Methods