Anvil
Public Member Functions | Static Public Member Functions | Properties | List of all members
Anvil.API.ObjectVariable< T > Class Template Referenceabstract

A key/value pair/variable stored on an Object. More...

+ Inheritance diagram for Anvil.API.ObjectVariable< T >:
+ Collaboration diagram for Anvil.API.ObjectVariable< T >:

Public Member Functions

abstract void Delete ()
 Deletes the value of this variable. More...
 
override bool Equals (object? obj)
 
bool Equals (ObjectVariable< T >? other)
 
override int GetHashCode ()
 

Static Public Member Functions

static implicit operator T? (ObjectVariable< T > value)
 Implicit conversion of the value of this variable. More...
 
static bool operator!= (ObjectVariable< T > left, ObjectVariable< T > right)
 
static bool operator== (ObjectVariable< T > left, ObjectVariable< T > right)
 

Properties

bool HasNothing [get]
 Gets a value indicating whether this variable has no value. More...
 
abstract bool HasValue [get]
 Gets a value indicating whether this variable has a value. More...
 
string Name = null! [get]
 
NwObject Object = null! [get]
 
abstract ? T Value [get, set]
 Gets or sets the current value of this variable. Returns the default value of T if unassigned (null or 0). More...
 

Detailed Description

A key/value pair/variable stored on an Object.

Member Function Documentation

◆ Delete()

abstract void Anvil.API.ObjectVariable< T >.Delete ( )
pure virtual

Deletes the value of this variable.

Implemented in Anvil.API.ObjectStorageVariableStruct< T >, Anvil.API.ObjectStorageVariableEnum< T >, Anvil.API.LocalVariableStruct< T >, Anvil.API.LocalVariableObject< T >, and Anvil.API.LocalVariableEnum< T >.

◆ operator T?()

static implicit Anvil.API.ObjectVariable< T >.operator T? ( ObjectVariable< T >  value)
inlinestatic

Implicit conversion of the value of this variable.

Property Documentation

◆ HasNothing

bool Anvil.API.ObjectVariable< T >.HasNothing
get

Gets a value indicating whether this variable has no value.

◆ HasValue

abstract bool Anvil.API.ObjectVariable< T >.HasValue
get

Gets a value indicating whether this variable has a value.

◆ Value

abstract ? T Anvil.API.ObjectVariable< T >.Value
getset

Gets or sets the current value of this variable. Returns the default value of T if unassigned (null or 0).

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