OptimizationStringParameter constructor

constructor · OptimizationStringParameter · cAlgo.API Since 5.9

DesktopCLICloud

Holds the parameter fixed at the given value.

Environment behaviour

CLI — not supported. Available to plugins only, and plugins cannot run in the CLI.

Cloud — not supported. Available to plugins only, and plugins cannot run in the cloud.

Overloads

Signature	Description
`OptimizationStringParameter(string name, string value)`	Holds the parameter fixed at the given value.
`OptimizationStringParameter(OptimizationStringParameter original)`

OptimizationStringParameter(string name, string value)

Holds the parameter fixed at the given value.

C#Python

public OptimizationStringParameter(string name, string value)

OptimizationStringParameter(name: str, value: str)

Parameters

Name	C# type	Python type	Description
`name`	`string`	`str`	The cBot parameter name.
`value`	`string`	`str`	The fixed value.

Examples

C#Python

var parameter = new OptimizationStringParameter("Comment", "Optimized by my plugin");
Print("{0} optimized: {1}", parameter.Name, parameter.IsOptimized);

parameter = OptimizationStringParameter("Comment", "Optimized by my plugin")
api.Print(f"{parameter.Name} optimized: {parameter.IsOptimized}")

OptimizationStringParameter(OptimizationStringParameter original)

C#Python

public OptimizationStringParameter(OptimizationStringParameter original)

OptimizationStringParameter(original: OptimizationStringParameter)

Parameters

Name	C# type	Python type	Description
`original`	`OptimizationStringParameter`	`OptimizationStringParameter`