GenerationService¶
Not yet Class NotCreatable Service
Service that allows developers to generate 3D objects from text prompts.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
0 Nova members · 22 modern Roblox members not implemented yet
Description¶
GenerationService enables you to generate 3D objects from text prompts using
Roblox's Cube 3D foundation model. This enables the generation of objects like
environmental props in-experience, as well as fully functional models like
vehicles that drive, planes that fly, and weapons that shoot.
Inheritance¶
Object → Instance → GenerationService
Methods¶
| Member | Signature | Summary |
|---|---|---|
ConnectAsync |
GenerationService:ConnectAsync(sessionId: string, sdp: string, type: string, relay: string): Tuple |
— |
DisconnectAsync |
GenerationService:DisconnectAsync(sessionId: string): bool |
— |
ExportInstanceToGlbAsync |
GenerationService:ExportInstanceToGlbAsync(rootInstance: Instance, userId: int64): string |
— |
ExportMeshToGlbAsync |
GenerationService:ExportMeshToGlbAsync(meshPart: MeshPart): string |
— |
GenerateMeshAsync |
GenerationService:GenerateMeshAsync(inputs: Dictionary, player: Player, options: Dictionary, intermediateResultCallback: Function?): Tuple |
Starts the generation of a new 3D mesh from a text prompt and returns unique IDs used to track and retrieve the result. |
GenerateModelAsync |
GenerationService:GenerateModelAsync(inputs: Dictionary, schema: Dictionary, options: Dictionary?): Tuple |
Enables generation of multi-mesh geometries according to provided inputs and a schema. |
GetVideoGenSessionAsync |
GenerationService:GetVideoGenSessionAsync(): Tuple |
— |
GetVideoGenTriggersAsync |
GenerationService:GetVideoGenTriggersAsync(sessionId: string, lookbackSeconds: int): Dictionary |
— |
InternalGenerateMeshAsync |
GenerationService:InternalGenerateMeshAsync(inputs: Dictionary, userId: int64, options: Dictionary, intermediateResultCallback: Function?): Tuple |
— |
LoadGeneratedMeshAsync |
GenerationService:LoadGeneratedMeshAsync(generationId: string): MeshPart |
Retrieves and loads a mesh generated by GenerationService.GenerateMeshAsync() using the provided generationId. |
LoadModelFromGlbAsync |
GenerationService:LoadModelFromGlbAsync(glbPath: string): Model |
— |
LoadModelFromUrlAsync |
GenerationService:LoadModelFromUrlAsync(url: string): Model |
— |
SegmentMeshAsync |
GenerationService:SegmentMeshAsync(meshPart: MeshPart, schema: Dictionary, options: Dictionary?): Tuple |
Segments an existing MeshPart into multiple named parts according to a provided schema, returning a Model organized by the schema groups. |
StartVideoGenSessionAsync |
GenerationService:StartVideoGenSessionAsync(sessionId: string, prompt: string, imageData: string, imageS3Reference: string, triggers: Dictionary): bool |
— |
UpdateVideoGenSessionPromptAsync |
GenerationService:UpdateVideoGenSessionPromptAsync(sessionId: string, prompt: string, imageData: string, imageS3Reference: string, mode: string): bool |
— |
UpdateVideoGenSessionTriggersAsync |
GenerationService:UpdateVideoGenSessionTriggersAsync(sessionId: string, triggers: Dictionary): bool |
— |
Events¶
| Member | Signature | Summary |
|---|---|---|
ReplicateGeneration |
ReplicateGeneration(id: string, success: bool, serializedModel: string) |
— |
RequestGenerationReplication |
RequestGenerationReplication(id: string) |
— |
Roblox reference: GenerationService
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.