Exploration

Learn how to use the CreativeEditor SDK's CreativeEngine to explore scenes through the block API.

Setup#

This example uses the headless CreativeEngine. See the Setup article for a detailed guide. To get started right away, you can also access the block API within a running CE.SDK instance via cesdk.engine.block. Check out the APIs Overview to see that illustrated in more detail.

Functions#

JavaScript


findAll(): DesignBlockId[]

Return all blocks currently known to the engine.

Returns A list of block ids.

JavaScript


findAllPlaceholders(): DesignBlockId[]

Return all placeholder blocks in the current scene.

Returns A list of block ids.

JavaScript


findByType(type: ObjectType): DesignBlockId[]

Finds all blocks with the given type.

type: The type to search for.
Returns A list of block ids.

JavaScript


findByKind(kind: string): DesignBlockId[]

Finds all blocks with the given kind.

kind: The kind to search for.
Returns A list of block ids.

JavaScript


findByName(name: string): DesignBlockId[]

Finds all blocks with the given name.

name: The name to search for.
Returns A list of block ids.


const allIds = engine.block.findAll();
const allPlaceholderIds = engine.block.findAllPlaceholders();
const allPages = engine.block.findByType('page');
const allImageFills = engine.block.findByType('fill/image');
const allStarShapes = engine.block.findByType('shape/star');
const allHalfToneEffects = try engine.block.findByType('effect/half_tone')
const allUniformBlurs = try engine.block.findByType('blur/uniform')
const allStickers = engine.block.findByKind('sticker');
const ids = engine.block.findByName('someName');