Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

PlayerSettings.GetPropertyOptionalBool

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public static function GetPropertyOptionalBool(name: string, value: bool, target: BuildTargetGroup = BuildTargetGroup.Unknown): bool;
public static bool GetPropertyOptionalBool(string name, bool value, BuildTargetGroup target = BuildTargetGroup.Unknown);

Parameters

nameName of the property.
valueVariable, to which to store the value of the property, if set.
targetAn optional build target group, to which the property applies.

Returns

bool True if property was set and it's value assigned to given variable.

Description

Searches for property and assigns it's value to given variable.

Property is not required to exist. If it doesn't exist, value variable will not be changed and this method will return false.