Static Public Member Functions

static string GetLastError ()

static Compatibility IsPluginCompatible ()

static Compatibility IsPluginCompatible (out string message)

static bool Initialize ()

static bool IsLicenseValid ()

static bool CheckSetup ()

static bool IsInitialized ()

static void CheckForUpdate ()

Offline License

Functions and attributes needed to deal with offline licenses.

Generate activation code to the file

Parameters

path

Returns: true if the generation succeed else else return false and store details (Configuration.GetLastError)

static bool GenerateDeactivationCode (string path)

static bool InstallActivationCode (string path)

Web License
Functions and attributes needed to deal with web licenses.
static bool	ConnectedToWebServer = false

static WebLicense	CurrentLicense `[get]`

static Plugin4UnityI.WebLicenseInfoList	Licenses `[get]`

static void	RefreshAvailableLicenses ()

static bool	ConnectToWebServer (string username, string password)

static bool	ReleaseWebLicense (int index)

static bool	RequestWebLicense (int index)

static bool	RetrieveCurrentLicense ()

Floating License
Functions and attributes needed to deal with floating licenses. summary>Class storing Floating license server settings
static bool	ConnectedToLicenseServer = false

static LicenseServer	CurrentLicenseServer `[get]`

static bool	IsFloatingLicense ()

static bool	RetrieveFloatingLicensingSetup ()

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

Tokens
Functions and attributes needed to deal with tokens. Class to store token data
static List< Token >?	Tokens `[get]`

static void	RetrieveTokens ()

static void	SelectAll ()

static void	DeselectAll ()

Detailed Description

Functions and attibutes are sorted between Web License, Floating License, Offline License and Tokens.

Member Function Documentation

◆ CheckForUpdate()

static void CheckForUpdate ( )

static

Check if there is a newer version of the plugin on pixyz website.

◆ CheckSetup()

static bool CheckSetup ( )

static

Checks all prerequisites

◆ ConfigureLicenseServer()

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

static

Try to connect to floating license server.

Parameters

address
port
useFlexLM

Returns: true if connection succeed, else return false and store details (Configuration.GetLastError)

◆ ConnectToWebServer()

static bool ConnectToWebServer	(	string	username,
		string	password
	)

static

Connect to PiXYZ web server using username and password.

This function automatically refresh the available licenses list.

See also: Configuration.Licenses

Parameters

username
password

Returns: true if the connection succeed

◆ DeselectAll()

static void DeselectAll ( )

static

Release all the tokens.

◆ GenerateDeactivationCode()

static bool GenerateDeactivationCode ( string path )

static

GenerateDeactivationCode

Parameters

path

Returns: true if the generation succeed else else return false and store details (Configuration.GetLastError)

◆ GetLastError()

static string GetLastError ( )

static

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

Returns: A string containing the error message.

◆ Initialize()

static bool Initialize ( )

static

Initialize the PiXYZ Plugin and try to retrieve the previously used license.

Returns: Return false if the initialization goes wrong.

◆ InstallActivationCode()

static bool InstallActivationCode ( string path )

static

InstallActivationCode

Parameters

path

Returns: true if the installation succeed else else return false and store details (Configuration.GetLastError)

◆ IsFloatingLicense()

static bool IsFloatingLicense ( )

static

Check if the current license is a floating.

Returns: true if the license is floating else return false

◆ IsInitialized()

static bool IsInitialized ( )

static

Check if the plugin is initialized.

This function does not initialize the product.

Returns: true if the plugin is initialized

◆ IsLicenseValid()

static bool IsLicenseValid ( )

static

Check if the current license is valid.

This function try to initialized the plugin if it's not initialized yet.

Returns: true if the plugin is initialized and if a valid license was found.

◆ IsPluginCompatible() [1/2]

static Compatibility IsPluginCompatible ( )

static

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

Returns

◆ IsPluginCompatible() [2/2]

static Compatibility IsPluginCompatible ( out string message )

static

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

Parameters

message Compatibility message

Returns

◆ RefreshAvailableLicenses()

static void RefreshAvailableLicenses ( )

static

Check on the web server the available licenses.

See also: Configuration.Licenses

◆ ReleaseWebLicense()

static bool ReleaseWebLicense ( int index )

static

Release installed license, this lets you install it on another computer.

Warning: This action is available only once per license.

Parameters

index

Returns: true if the releasing succeed, else return false and store details (Configuration.GetLastError)

◆ RequestWebLicense()

static bool RequestWebLicense ( int index )

static

Request license, this install the license on your computer.

Parameters

index

Returns: true if the installation succeed, else return false and store details (Configuration.GetLastError)

◆ RetrieveCurrentLicense()

static bool RetrieveCurrentLicense ( )

static

Retrieve current valid license.

Returns: true if a valid license is found, else return false and store details (Configuration.GetLastError)

◆ RetrieveFloatingLicensingSetup()

static bool RetrieveFloatingLicensingSetup ( )

static

Retrieve last floating license server settings used.

Returns: true if CurrentLicenseServer is updated, else return false and store details (Configuration.GetLastError)

◆ RetrieveTokens()

static void RetrieveTokens ( )

static

update the Tokens list

See also: Configuration.Tokens

◆ SelectAll()

static void SelectAll ( )

static

Request all the tokens.

Member Data Documentation

◆ ConnectedToLicenseServer

bool ConnectedToLicenseServer = false

static

This attribute is set to true when the plugin succeed to connect to a PiXYZ floating license server.

◆ ConnectedToWebServer

bool ConnectedToWebServer = false

static

This attribute is set to true when the plugin succeed to connect to a PiXYZ web server.

Property Documentation

◆ CurrentLicense

WebLicense CurrentLicense

staticget

License currently used by the plugin.

Need to be connected to a web server.

◆ CurrentLicenseServer

LicenseServer CurrentLicenseServer

staticget

Current floating license server settings.

◆ Licenses

Plugin4UnityI.WebLicenseInfoList Licenses

staticget

The licenses available on the web server.

This list is not updated in realtime.

See also: Configuration.RefreshAvailableLicenses.

◆ Tokens

List<Token>? Tokens

staticget

list of tokens known by the plugin