Anvil
Anvil.API.SQLResult Class Reference

Represents a row returned in an SQL result. See SQLQuery.Result/SQLQuery.Results. More...

Public Member Functions

float GetFloat (int columnIndex)
 Gets the float result for the specified column. More...
 
float GetFloat (string columnName)
 Gets the float result for the specified column. More...
 
int GetInt (int columnIndex)
 Gets the int result for the specified column. More...
 
float GetInt (string columnName)
 Gets the int result for the specified column. More...
 
T? GetObject< T > (int columnIndex, Location spawnLocation, NwGameObject? targetInventory=null)
 Gets the serialized object result for the specified column, and spawns the object at the specified location and inventory. More...
 
T? GetObject< T > (string columnName, Location spawnLocation, NwGameObject? targetInventory=null)
 Gets the serialized object result for the specified column, and spawns the object at the specified location and inventory. More...
 
string GetString (int columnIndex)
 Gets the string result for the specified column. More...
 
string GetString (string columnName)
 Gets the string result for the specified column. More...
 
Vector3 GetVector3 (int columnIndex)
 Gets the Vector3 result for the specified column. More...
 
Vector3 GetVector3 (string columnName)
 Gets the Vector3 result for the specified column. More...
 

Detailed Description

Represents a row returned in an SQL result. See SQLQuery.Result/SQLQuery.Results.

Member Function Documentation

◆ GetFloat() [1/2]

float Anvil.API.SQLResult.GetFloat ( int  columnIndex)
inline

Gets the float result for the specified column.

Parameters
columnIndexThe 0-based index of the column to query.
Returns
The float result. Returns 0.0f on an error.

◆ GetFloat() [2/2]

float Anvil.API.SQLResult.GetFloat ( string  columnName)
inline

Gets the float result for the specified column.

Parameters
columnNameThe name of the column to fetch the result.
Returns
The float result. Returns 0.0f on an error.

◆ GetInt() [1/2]

int Anvil.API.SQLResult.GetInt ( int  columnIndex)
inline

Gets the int result for the specified column.

Parameters
columnIndexThe 0-based index of the column to query.
Returns
The int result. Returns 0 on an error.

◆ GetInt() [2/2]

float Anvil.API.SQLResult.GetInt ( string  columnName)
inline

Gets the int result for the specified column.

Parameters
columnNameThe name of the column to fetch the result.
Returns
The int result. Returns 0.0f on an error.

◆ GetObject< T >() [1/2]

T? Anvil.API.SQLResult.GetObject< T > ( int  columnIndex,
Location  spawnLocation,
NwGameObject targetInventory = null 
)
inline

Gets the serialized object result for the specified column, and spawns the object at the specified location and inventory.

Parameters
columnIndexThe 0-based index of the column to query.
spawnLocationThe location to spawn the object.
targetInventory(Items only) The target inventory for the item.
Returns
The deserialized object. Returns null on an error.
Type Constraints
T :NwObject 

◆ GetObject< T >() [2/2]

T? Anvil.API.SQLResult.GetObject< T > ( string  columnName,
Location  spawnLocation,
NwGameObject targetInventory = null 
)
inline

Gets the serialized object result for the specified column, and spawns the object at the specified location and inventory.

Parameters
columnNameThe name of the column to fetch the result.
spawnLocationThe location to spawn the object.
targetInventory(Items only) The target inventory for the item.
Returns
The deserialized object. Returns null on an error.
Type Constraints
T :NwObject 

◆ GetString() [1/2]

string Anvil.API.SQLResult.GetString ( int  columnIndex)
inline

Gets the string result for the specified column.

Parameters
columnIndexThe 0-based index of the column to query.
Returns
The string result. Returns "" on an error.

◆ GetString() [2/2]

string Anvil.API.SQLResult.GetString ( string  columnName)
inline

Gets the string result for the specified column.

Parameters
columnNameThe name of the column to fetch the result.
Returns
The string result. Returns "" on an error.

◆ GetVector3() [1/2]

Vector3 Anvil.API.SQLResult.GetVector3 ( int  columnIndex)
inline

Gets the Vector3 result for the specified column.

Parameters
columnIndexThe 0-based index of the column to query.
Returns
The Vector3 result. Returns Vector3.Zero on an error.

◆ GetVector3() [2/2]

Vector3 Anvil.API.SQLResult.GetVector3 ( string  columnName)
inline

Gets the Vector3 result for the specified column.

Parameters
columnNameThe name of the column to fetch the result.
Returns
The Vector3 result. Returns Vector3.Zero on an error.

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