A GffResourceField containing a structure of key/value pairs. More...

Inheritance diagram for Anvil.API.GffResourceFieldStruct:

Collaboration diagram for Anvil.API.GffResourceFieldStruct:

Public Member Functions
override bool	ContainsKey (string key)
	If this field is a GffResourceFieldStruct, determines if the specified key exists in the structure. More...

IEnumerator< KeyValuePair< string, GffResourceField > >	GetEnumerator ()

override bool	TryGetValue (string key, [NotNullWhen(true)] out GffResourceField? value)
	If this field is a GffResourceFieldStruct, gets the value associated with the specified key. More...

Public Member Functions inherited from Anvil.API.GffResourceField
sealed override? string	ToString ()

object?	Value ()
	Gets the value of this field. More...

T?	Value< T > ()
	Gets the value of this field. More...

object?	ValueOrDefault ()
	Gets the value of this field. More...

T?	ValueOrDefault< T > ()
	Gets the value of this field. More...

Properties
override int	Count `[get]`

override IEnumerable< KeyValuePair< string, GffResourceField > >	EntrySet `[get]`

override GffResourceFieldType	FieldType `[get]`

override IEnumerable< string >	Keys `[get]`

override GffResourceField	this[int index] `[get]`

override GffResourceField	this[string key] `[get]`

override IEnumerable< GffResourceField >	Values `[get]`

Properties inherited from Anvil.API.GffResourceField
virtual int	Count `[get]`
	Gets the number of child fields. More...

virtual IEnumerable< KeyValuePair< string, GffResourceField > >	EntrySet = Enumerable.Empty<KeyValuePair<string, GffResourceField>>() `[get]`
	If this field is a struct, gets an enumerable of the key/values pairs. Otherwise, returns an empty enumerable. More...

abstract GffResourceFieldType	FieldType `[get]`
	Gets the GFF field type. More...

bool	HasChildren `[get]`
	Gets whether this field contains child values. More...

virtual IEnumerable< string >	Keys = Enumerable.Empty<string>() `[get]`
	If this field is a struct, gets an enumerable of the struct's keys. Otherwise, returns an empty enumerable. More...

virtual GffResourceField	this[int index] `[get]`
	Gets the child GffResourceField at the specified index. More...

virtual GffResourceField	this[string key] `[get]`
	Gets the child GffResourceField with the specified key. More...

virtual IEnumerable< GffResourceField >	Values = Enumerable.Empty<GffResourceField>() `[get]`
	If this field is an array, gets an enumerable of the array's values. If this field is a struct, gets an enumerable of the struct's values. Otherwise, returns an empty enumerable. More...

Additional Inherited Members
Static Public Member Functions inherited from Anvil.API.GffResourceField
static	operator byte (GffResourceField field)

static	operator double (GffResourceField field)

static	operator float (GffResourceField field)

static	operator int (GffResourceField field)

static	operator long (GffResourceField field)

static	operator short (GffResourceField field)

static	operator string? (GffResourceField field)

static	operator uint (GffResourceField field)

static	operator ulong (GffResourceField field)

static	operator ushort (GffResourceField field)

Protected Member Functions inherited from Anvil.API.GffResourceField
	GffResourceField (CResGFF resGff)

virtual bool	GetValueInternal (out object? value, Type? requestedType=null)

Protected Attributes inherited from Anvil.API.GffResourceField
readonly CResGFF	ResGff

Detailed Description

A GffResourceField containing a structure of key/value pairs.

Member Function Documentation

◆ ContainsKey()

override bool Anvil.API.GffResourceFieldStruct.ContainsKey ( string key )

inlinevirtual

If this field is a GffResourceFieldStruct, determines if the specified key exists in the structure.

Parameters

key	The key to locate in the GffResourceFieldStruct./

Returns: True if the field is a GffResourceFieldStruct and the key exists. Otherwise, false.

Reimplemented from Anvil.API.GffResourceField.

◆ TryGetValue()

override bool Anvil.API.GffResourceFieldStruct.TryGetValue	(	string	key,
		[NotNullWhen(true)] out GffResourceField?	value
	)

inlinevirtual

If this field is a GffResourceFieldStruct, gets the value associated with the specified key.

Parameters

key	The key of the value to get./
value	If the method runs successfully (returns true), this output parameter will contain the associated value.

Returns: True if the field is a GffResourceFieldStruct and the key exists. Otherwise, false.

Reimplemented from Anvil.API.GffResourceField.

The documentation for this class was generated from the following file:

NWN.Anvil/src/main/API/Resources/Gff/Fields/GffResourceFieldStruct.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ContainsKey()

◆ TryGetValue()