ClassFunction
| 📊 Overview: 8 Properties | 1 Constructor | 3 Functions |
📝 Description
Creates a new class function metadata object with the specified function name
🕐 Last updated: 2025-12-10T11:45:22.432Z
📑 Table of Contents
- 📋 Properties (8)
- 🏗️ Constructor (1 param)
- ⚙️ Functions
- Regular Functions
- addModifier (1 param)
- addParameter (1 param)
- toObject →
Object
- Regular Functions
Properties
| Property | Type | Default | Description |
|---|---|---|---|
Name | Text | - | The name of the function |
Modifiers | Collection | [] | Collection of function modifiers (local, exposed, etc.) |
IsGetter | Boolean | False | Indicates if this is a getter function |
IsSetter | Boolean | False | Indicates if this is a setter function |
Parameters | Collection | [] | Collection of ClassParameter objects defining function parameters |
ReturnType | Text | "" | The return type of the function |
LineNumber | Integer | 0 | Line number where the function is defined in the source file |
DocComment | Text | "" | Documentation comment for the function |
Constructor
constructor
[🏗️ constructor]
Class constructor($Name : Text)
Creates a new class function metadata object with the specified function name
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$Name | Text | - | - |
Functions
Regular Functions
addModifier
Function addModifier($Modifier : Text)
Adds a modifier (e.g., “local”, “exposed”) to the function’s modifiers collection
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$Modifier | Text | - | - |
addParameter
Function addParameter($Parameter : cs.ClassParameter)
Adds a parameter definition to the function’s parameters collection
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$Parameter | cs.ClassParameter | - | - |
toObject
Function toObject -> Object
Converts the function metadata to an object suitable for JSON serialization
Returns: Object
Generated from ClassFunction.4dm