Main Class for handling SUKI related functionalities for accessing, changing and tracking of game inputs. More...

Inherits MonoBehaviour.

Public Member Functions
float	GetExtentMin (string name)
	Gets the minimum extent value for the specified schema name.

void	SetExtentMin (string name, float value)
	Sets the minimum extent value for a specified schema name.

float	GetExtentMax (string name)
	Retrieves the maximum extent value for a given schema name.

void	SetExtentMax (string name, float value)
	Sets the maximum extent value for a given schema.

Vector2	GetExtentMin2D (string name)
	Get the minimum 2D extent value of a schema with the given name.

void	SetExtentMin2D (string name, Vector2 value)
	Sets the minimum 2D extent for the specified schema.

Vector3	GetExtentMax2D (string name)
	Retrieves the maximum 2D extent of a given schema.

void	SetExtentMax2D (string name, Vector2 value)
	Sets the maximum 2D extent for a given schema.

Vector3	GetExtentMin3D (string name)
	Returns the minimum 3D extent value for a given name.

Vector3	GetExtentMax3D (string name)
	Returns the maximum 3D extent of a specified schema.

bool	GetTrigger (string name)
	Retrieves the value of a trigger with the given name.

bool	GetSignal (string name)
	Retrieves the value of the specified signal.

float	GetRange (string name)
	Returns the range value associated with the given name.

Vector2	GetLocation2D (string name)
	Gets the 2D location of an input based on the specified name.

Vector3	GetLocation3D (string name)
	Retrieves the value of a 3D location with the given name.

bool	TriggerExists (string name)
	Checks if a trigger with the given name exists.

bool	SignalExists (string name)
	Checks if the specified signal exists.

bool	RangeExists (string name)
	Checks if a range with the specified name exists.

bool	Location2DExists (string name)
	Determines whether the specified 2D location exists in the Suki input data.

bool	Location3DExists (string name)
	Determines if a 3D location with the given name exists.

List< string >	GetAllRange ()
	Retrieves all the keys of the ranges that have been loaded.

Properties
bool	Updating `[get]`
	Indicates whether the SukiInput data is currently being updated (changing).

Detailed Description

Main Class for handling SUKI related functionalities for accessing, changing and tracking of game inputs.

Member Function Documentation

◆ GetAllRange()

List< string > Enablegames.Suki.SukiInput.GetAllRange ( )

inline

Retrieves all the keys of the ranges that have been loaded.

Returns: A List of strings representing the keys of all the ranges.

◆ GetExtentMax()

float Enablegames.Suki.SukiInput.GetExtentMax ( string name )

inline

Retrieves the maximum extent value for a given schema name.

Parameters

name	The name of the schema to retrieve the extent value for.

Returns: The maximum extent value of the schema.

Here is the call graph for this function:

◆ GetExtentMax2D()

Vector3 Enablegames.Suki.SukiInput.GetExtentMax2D ( string name )

inline

Retrieves the maximum 2D extent of a given schema.

Parameters

name	The name of the schema.

Returns: The maximum 2D extent of the schema, or Vector2.zero if the schema does not exist.

Here is the call graph for this function:

◆ GetExtentMax3D()

Vector3 Enablegames.Suki.SukiInput.GetExtentMax3D ( string name )

inline

Returns the maximum 3D extent of a specified schema.

Parameters

name	The name of the schema.

Returns: The maximum 3D extent of the specified schema.

Here is the call graph for this function:

◆ GetExtentMin()

float Enablegames.Suki.SukiInput.GetExtentMin ( string name )

inline

Gets the minimum extent value for the specified schema name.

Parameters

name	The name of the schema.

Returns: The minimum extent value of the specified schema.

Here is the call graph for this function:

◆ GetExtentMin2D()

Vector2 Enablegames.Suki.SukiInput.GetExtentMin2D ( string name )

inline

Get the minimum 2D extent value of a schema with the given name.

Parameters

name	The name of the schema.

Returns: The minimum 2D extent value of the schema with the given name. If no schema with the given name is found, returns Vector2.zero.

Here is the call graph for this function:

◆ GetExtentMin3D()

Vector3 Enablegames.Suki.SukiInput.GetExtentMin3D ( string name )

inline

Returns the minimum 3D extent value for a given name.

Parameters

name	The name of the schema.

Returns: The minimum 3D extent value for the given name.

Here is the call graph for this function:

◆ GetLocation2D()

Vector2 Enablegames.Suki.SukiInput.GetLocation2D ( string name )

inline

Gets the 2D location of an input based on the specified name.

Parameters

name	The name of the input.

Returns: The 2D location of the input.

◆ GetLocation3D()

Vector3 Enablegames.Suki.SukiInput.GetLocation3D ( string name )

inline

Retrieves the value of a 3D location with the given name.

Parameters

name	The name of the 3D location to retrieve.

Returns: The 3D location with the given name.

Exceptions

KeyNotFoundException Thrown if the 3D location with the given name does not exist.

◆ GetRange()

float Enablegames.Suki.SukiInput.GetRange ( string name )

inline

Returns the range value associated with the given name.

Parameters

name	The name of the range value.

Returns: The range value.

◆ GetSignal()

bool Enablegames.Suki.SukiInput.GetSignal ( string name )

inline

Retrieves the value of the specified signal.

Parameters

name	The name of the signal to retrieve.

Returns: True if the signal exists and is active, false otherwise.

◆ GetTrigger()

bool Enablegames.Suki.SukiInput.GetTrigger ( string name )

inline

Retrieves the value of a trigger with the given name.

Parameters

name	The name of the trigger to retrieve.

Returns: True if the trigger is active, false otherwise.

◆ Location2DExists()

bool Enablegames.Suki.SukiInput.Location2DExists ( string name )

inline

Determines whether the specified 2D location exists in the Suki input data.

Parameters

name	The name of the 2D location.

Returns: True if the specified 2D location exists, False otherwise.

◆ Location3DExists()

bool Enablegames.Suki.SukiInput.Location3DExists ( string name )

inline

Determines if a 3D location with the given name exists.

Parameters

name	The name of the 3D location to check for existence.

Returns: True if the 3D location exists, false otherwise.

◆ RangeExists()

bool Enablegames.Suki.SukiInput.RangeExists ( string name )

inline

Checks if a range with the specified name exists.

Parameters

name	The name of the range to check.

Returns: true if the range exists, false otherwise.

◆ SetExtentMax()

void Enablegames.Suki.SukiInput.SetExtentMax	(	string	name,
		float	value )

inline

Sets the maximum extent value for a given schema.

Parameters

name	The name of the schema.
value	The new maximum extent value.

Exceptions

ArgumentOutOfRangeException Thrown when the schema with the specified name does not exist.

Here is the call graph for this function:

◆ SetExtentMax2D()

void Enablegames.Suki.SukiInput.SetExtentMax2D	(	string	name,
		Vector2	value )

inline

Sets the maximum 2D extent for a given schema.

Parameters

name	The name of the schema.
value	The maximum 2D extent value to set.

Exceptions

ArgumentOutOfRangeException Thrown when the schema with the specified name does not exist.

Here is the call graph for this function:

◆ SetExtentMin()

void Enablegames.Suki.SukiInput.SetExtentMin	(	string	name,
		float	value )

inline

Sets the minimum extent value for a specified schema name.

Parameters

name	The name of the schema to set the extent for.
value	The minimum extent value to set.

Exceptions

ArgumentOutOfRangeException Thrown when the schema with the specified name does not exist.

Here is the call graph for this function:

◆ SetExtentMin2D()

void Enablegames.Suki.SukiInput.SetExtentMin2D	(	string	name,
		Vector2	value )

inline

Sets the minimum 2D extent for the specified schema.

Parameters

name	The name of the schema.
value	The new minimum 2D extent.

Exceptions

ArgumentOutOfRangeException Thrown when the schema with the specified name does not exist.

Here is the call graph for this function:

◆ SignalExists()

bool Enablegames.Suki.SukiInput.SignalExists ( string name )

inline

Checks if the specified signal exists.

Parameters

name	The name of the signal.

Returns: True if the signal exists; otherwise, false.

◆ TriggerExists()

bool Enablegames.Suki.SukiInput.TriggerExists ( string name )

inline

Checks if a trigger with the given name exists.

Parameters

name	The name of the trigger to check.

Returns: True if the trigger exists, false otherwise.

This method is used to determine if a trigger with the specified name exists in the SukiData instance.

Property Documentation

◆ Updating

bool Enablegames.Suki.SukiInput.Updating

get

Indicates whether the SukiInput data is currently being updated (changing).

true if the SukiInput data is currently being updated; otherwise, false.

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

/Users/yiyangshang/egdl2/Assets/eag/Scripts/enablegames/Suki/scripts/SukiInput.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ GetAllRange()

◆ GetExtentMax()

◆ GetExtentMax2D()

◆ GetExtentMax3D()

◆ GetExtentMin()

◆ GetExtentMin2D()

◆ GetExtentMin3D()

◆ GetLocation2D()

◆ GetLocation3D()

◆ GetRange()

◆ GetSignal()

◆ GetTrigger()

◆ Location2DExists()

◆ Location3DExists()

◆ RangeExists()

◆ SetExtentMax()

◆ SetExtentMax2D()

◆ SetExtentMin()

◆ SetExtentMin2D()

◆ SignalExists()

◆ TriggerExists()

Property Documentation

◆ Updating