forEachProperty Method
Deprecated in 5.0. Please use forEach to get the metadata and iterate over the properties instead.
Call a function for each property of this Entity.
forEachProperty(func: PropertyCallback, includeCustom: booleantrue): void
@note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
@example
// Deprecated method
entity.forEachProperty((name, propMetaData) => {
console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);
});
// New method
entity.forEach((name, property) => {
console.log(`Property name: ${name}, Property type: ${property.propertyType}`);
});
| Parameter | Type | Description |
|---|---|---|
| func | PropertyCallback | The callback to be invoked on each property |
| includeCustom | boolean | If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties. |
Returns - void
Defined in
- core/backend/src/Entity.ts Line 211
Last Updated: 14 June, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.