Class Configuration

Inheritance

System.Object

Configuration

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: PiXYZ.Config

Assembly: cs.temp.dll.dll

Syntax

public static class Configuration

Fields

unityVersion

Declaration

public static double unityVersion

Field Value

Type	Description
System.Double

Properties

CurrentLicense

License currently used by the plugin. Need to be connected to a web server.

Declaration

public static NativeInterface.LicenseInfos CurrentLicense { get; set; }

Property Value

Type	Description
PiXYZ.Plugin4Unity.NativeInterface.LicenseInfos

CurrentLicenseServer

Current floating license server settings.

Declaration

public static LicenseServer CurrentLicenseServer { get; }

Property Value

Type	Description
LicenseServer

DocumentationURL

Declaration

public static string DocumentationURL { get; }

Property Value

Type	Description
System.String

Licenses

The licenses available on the web server. This list is not updated in realtime. \see @ref Configuration::RefreshAvailableLicenses.

Declaration

public static NativeInterface.WebLicenseInfoList Licenses { get; }

Property Value

Type	Description
PiXYZ.Plugin4Unity.NativeInterface.WebLicenseInfoList

PiXYZVersion

Declaration

public static string PiXYZVersion { get; }

Property Value

Type	Description
System.String

Tokens

list of tokens known by the plugin

Declaration

public static Token[] Tokens { get; }

Property Value

Type	Description
Token[]

UnityVersion

Declaration

public static double UnityVersion { get; }

Property Value

Type	Description
System.Double

UpdateStatus

Declaration

public static NativeInterface.checkForUpdatesReturn? UpdateStatus { get; }

Property Value

Type	Description
System.Nullable<PiXYZ.Plugin4Unity.NativeInterface.checkForUpdatesReturn>

Username

Declaration

public static string Username { get; }

Property Value

Type	Description
System.String

WebsiteURL

Declaration

public static string WebsiteURL { get; }

Property Value

Type	Description
System.String

Methods

CheckForUpdate()

Check if there is a newer version of the plugin on pixyz website. Freezes until the check is finished. It can take several seconds if the network is busy or weak. Result is cached so that further calls are fast.

Declaration

public static NativeInterface.checkForUpdatesReturn CheckForUpdate()

Returns

Type	Description
PiXYZ.Plugin4Unity.NativeInterface.checkForUpdatesReturn

CheckLicense()

Check if the current license is valid. This function try to initialized the plugin if it's not initialized yet.

Declaration

public static bool CheckLicense()

Returns

Type	Description
System.Boolean	true if the plugin is initialized and if a valid license was found.

ConfigureLicenseServer(String, UInt16, Boolean)

Try to connect to floating license server.

Declaration

public static bool ConfigureLicenseServer(string address, ushort port, bool useFlexLM)

Parameters

Type	Name	Description
System.String	address	License server IP address
System.UInt16	port	License server port
System.Boolean	useFlexLM	If true, use FlexLM license server

Returns

Type	Description
System.Boolean	Returns true if connection succeed, else return false and store details (@ref Configuration::GetLastError)

ConnectToWebServer(String, String)

Connect to PiXYZ web server using username and password. This function automatically refresh the available licenses list. \see @ref Configuration::Licenses

Declaration

public static bool ConnectToWebServer(string username, string password)

Parameters

Type	Name	Description
System.String	username
System.String	password

Returns

Type	Description
System.Boolean	true if the connection succeed

DisconnectFromWebServer()

Declaration

public static bool DisconnectFromWebServer()

Returns

Type	Description
System.Boolean

GenerateActivationCode(String)

Generate activation code to the file

Declaration

public static bool GenerateActivationCode(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
System.Boolean	true if the generation succeed else else return false and store details (@ref Configuration::GetLastError)

GenerateDeactivationCode(String)

GenerateDeactivationCode

Declaration

public static bool GenerateDeactivationCode(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
System.Boolean	true if the generation succeed else else return false and store details (@ref Configuration::GetLastError)

GetLastError()

Get the lastError catch by this class during one of its function execution.

Declaration

public static string GetLastError()

Returns

Type	Description
System.String	A string containing the error message.

InstallActivationCode(String)

InstallActivationCode

Declaration

public static bool InstallActivationCode(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
System.Boolean	true if the installation succeed else else return false and store details (@ref Configuration::GetLastError)

IsBetaVersion()

Returns true if this PiXYZ for Unity plugin version is a beta

Declaration

public static bool IsBetaVersion()

Returns

Type	Description
System.Boolean

IsConnectedToWebServer()

Declaration

public static bool IsConnectedToWebServer()

Returns

Type	Description
System.Boolean

IsFloatingLicense()

Check if the current license is a floating.

Declaration

public static bool IsFloatingLicense()

Returns

Type	Description
System.Boolean	true if the license is floating else return false

IsPluginCompatible()

Returns true if the current Unity version is compatible with this PiXYZ for Unity plugin version

Declaration

public static Compatibility IsPluginCompatible()

Returns

Type	Description
Compatibility

IsPluginCompatible(out String)

Returns true if the current Unity version is compatible with this PiXYZ for Unity plugin version Also returns a message

Declaration

public static Compatibility IsPluginCompatible(out string message)

Parameters

Type	Name	Description
System.String	message	Compatibility message

Returns

Type	Description
Compatibility

RefreshAvailableLicenses()

Check on the web server the available licenses. \see @ref Configuration::Licenses

Declaration

public static void RefreshAvailableLicenses()

ReleaseWebLicense(NativeInterface.WebLicenseInfo)

Release installed license, this lets you install it on another computer. \warning This action is available only once per license.

Declaration

public static bool ReleaseWebLicense(NativeInterface.WebLicenseInfo license)

Parameters

Type	Name	Description
PiXYZ.Plugin4Unity.NativeInterface.WebLicenseInfo	license

Returns

Type	Description
System.Boolean	true if the releasing succeed, else return false and store details (@ref Configuration::GetLastError)

RequestWebLicense(NativeInterface.WebLicenseInfo)

Request license, this install the license on your computer.

Declaration

public static bool RequestWebLicense(NativeInterface.WebLicenseInfo license)

Parameters

Type	Name	Description
PiXYZ.Plugin4Unity.NativeInterface.WebLicenseInfo	license

Returns

Type	Description
System.Boolean	true if the installation succeed, else return false and store details (@ref Configuration::GetLastError)

RetrieveCurrentLicense()

Retrieve current valid license.

Declaration

public static bool RetrieveCurrentLicense()

Returns

Type	Description
System.Boolean	true if a valid license is found, else return false and store details (@ref Configuration::GetLastError)

RetrieveFloatingLicensingSetup()

Retrieve last floating license server settings used.

Declaration

public static bool RetrieveFloatingLicensingSetup()

Returns

Type	Description
System.Boolean	true if CurrentLicenseServer is updated, else return false and store details (@ref Configuration::GetLastError)