Search Results for

    Show / Hide Table of Contents

    Class Parameters

    Inheritance
    Object
    Parameters
    Namespace: Clavusaurus.Cosmos
    Assembly: cs.temp.dll.dll
    Syntax
    public class Parameters

    Properties

    Count

    Declaration
    public int Count { get; }
    Property Value
    Type Description
    Int32

    Keys

    All the keys used in this list of parameters. Any implicit parameter that's not part of the command definition will use a key with the format "___undef0" where the last number increments.

    Declaration
    public string[] Keys { get; }
    Property Value
    Type Description
    String[]

    Methods

    Get(Int32)

    Returns the string value at the parameter index

    Declaration
    public string Get(int index)
    Parameters
    Type Name Description
    Int32 index
    Returns
    Type Description
    String

    Get(String)

    Returns the string value associated with the key, returns empty string if not in the list of parameters

    Declaration
    public string Get(string key)
    Parameters
    Type Name Description
    String key
    Returns
    Type Description
    String

    GetBool(Int32)

    Returns the bool value at the parameter index

    Declaration
    public bool GetBool(int index)
    Parameters
    Type Name Description
    Int32 index
    Returns
    Type Description
    Boolean

    GetBool(String)

    Returns the boolean value associated with the key, also returns false if not in the list of parameters

    Declaration
    public bool GetBool(string key)
    Parameters
    Type Name Description
    String key
    Returns
    Type Description
    Boolean

    GetFloat(Int32)

    Returns the float value at the parameter index

    Declaration
    public float GetFloat(int index)
    Parameters
    Type Name Description
    Int32 index
    Returns
    Type Description
    Single

    GetFloat(String)

    Returns the float value associated with the key, returns 0 if not in the list of parameters

    Declaration
    public float GetFloat(string key)
    Parameters
    Type Name Description
    String key
    Returns
    Type Description
    Single

    GetInt(Int32)

    Returns the int value at the parameter index

    Declaration
    public int GetInt(int index)
    Parameters
    Type Name Description
    Int32 index
    Returns
    Type Description
    Int32

    GetInt(String)

    Returns the int value associated with the key, returns 0 if not in the list of parameters

    Declaration
    public int GetInt(string key)
    Parameters
    Type Name Description
    String key
    Returns
    Type Description
    Int32

    Has(String)

    Returns true if the parameter with the specified key was entered

    Declaration
    public bool Has(string key)
    Parameters
    Type Name Description
    String key
    Returns
    Type Description
    Boolean

    TryGet(String, out String)

    Provides the string value associated with the key, returns false if not in the list of parameters

    Declaration
    public bool TryGet(string key, out string value)
    Parameters
    Type Name Description
    String key
    String value
    Returns
    Type Description
    Boolean

    TryGetBool(String, out Boolean)

    Provides the boolean value associated with the key, returns false if not in the list of parameters

    Declaration
    public bool TryGetBool(string key, out bool value)
    Parameters
    Type Name Description
    String key
    Boolean value
    Returns
    Type Description
    Boolean

    TryGetFloat(String, out Single)

    Provides the float value associated with the key, returns false if not in the list of parameters

    Declaration
    public bool TryGetFloat(string key, out float value)
    Parameters
    Type Name Description
    String key
    Single value
    Returns
    Type Description
    Boolean

    TryGetInt(String, out Int32)

    Provides the int value associated with the key, returns false if not in the list of parameters

    Declaration
    public bool TryGetInt(string key, out int value)
    Parameters
    Type Name Description
    String key
    Int32 value
    Returns
    Type Description
    Boolean
    ☀
    ☾
    In This Article
    Back to top
    © Clavusaurus Game Software
    ☀
    ☾