Script.isFavorite Property

Parent Object: Script
Defined in namespace "adsk::core" and the header file is <Core/Application/Script.h>

Description

Gets and sets whether this script or add-in is a favorite of the user.

Syntax

"script_var" is a variable referencing a Script object.
# Get the value of the property.
propertyValue = script_var.isFavorite

# Set the value of the property.
script_var.isFavorite = propertyValue
"script_var" Is a variable referencing a Script Object.
#include <Core/Application/Script.h>

// Get the value of the property.
boolean propertyValue = script_var->isFavorite();

// Set the value of the property, where value_var is a boolean.
bool returnValue = script_var->isFavorite(value_var);
"script_var" Is a variable referencing a Script Object.
// Get the value of the property.
propertyValue = script_var.isFavorite;

// Set the value of the property.
script_var.isFavorite = propertyValue;

Property Value

This is a read/write property whose value is a boolean.

Version

Introduced in version January 2025