11 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

Assistant prompt guide and examples

Note

Share your prompts and games in the Roblox forum so that we can make Assistant better!

This document gives guidance on prompting Assistant and provides examples and inspiration on what Assistant can do.

Best practices

These best practices can help you get better results when using Assistant. Try them out and see what works best for your workflow.

Be specific

If Assistant fails, add more details to your prompt and try again. Use instance names exactly as they're spelled, specify which function you want Assistant to use, and tell Assistant which type it's working with, such as a part or a model.

Use your selection

Selection is a great way of specifying an object or set of objects you want to refer to in your prompt. Select multiple objects and ask Assistant to modify them, make duplicates and place them somewhere, or continue a position pattern like maintaining placement in a line.

Edit time and run time

Assistant sometimes confuses the difference between edit time and run time. If you ask Assistant to take an action, it will likely bias towards doing it at edit time. If you want the action to happen during run time, ask Assistant to insert a script that takes the action. For example, tell Assistant "add a script to make the time of day 8:00 AM" instead of "make the time of day 8:00 AM."

Multi-step prompts

Consider using multi-step prompts to encourage Assistant to think. Instead of asking "Can you explain this script to me?" and pasting in the script, ask it to explain step-by-step by separating the question from the script with ###. This separation helps Assistant deconstruct and organize the information to provide better answers.

Prompt

Can you explain what this script is doing step by step?

###

local part = workspace.Part

local function onTouched(otherPart)
    print(part.Name .. " collided with " .. otherPart.Name)
end

part.Touched:Connect(onTouched)

###

Assistant response

Certainly! This script is an example of how to handle collisions between two parts in Roblox. Let's break it down step by step:

1. local part = workspace.Part: This line of code creates a local variable named part and assigns it the value of the Part object located in the workspace. You can replace Part with the name of the specific part you want to detect collisions with.
2. local function onTouched(otherPart): This line of code defines a function named onTouched that takes in a parameter otherPart. This function will be called whenever the part collides with another part.
3. print(part.Name .. " collided with " .. otherPart.Name): This line of code prints a message to the output console, indicating that the part has collided with otherPart. The part.Name and otherPart.Name are concatenated using the .. operator to form the message.
4. part.Touched:Connect(onTouched): This line of code connects the onTouched function to the Touched event of part. Whenever the part collides with another part, the onTouched function will be called.

Prompting for asset generation

When generating assets, start by naming the object and then gradually add details about its appearance. Assistant automatically determines the camera angle, background, and lighting, so you only need to describe the object itself.

Avoid describing the image rather than the object. For example, don't include:

• Backgrounds or environments, like "white background" or "studio backdrop".
• Camera angles or composition, like "3/4 view" or "front shot".
• Lighting, like "clean shadows" or "cinematic lighting".
• Generic quality terms, like "high quality" or "4K".

Prompting for procedural model generation

Procedural model generation can take longer than text responses. To continue working efficiently, you can keep typing your next prompt while Assistant is generating your model.

When writing prompts for procedural models, make sure to explicitly specify the properties and parameters you want to be able to edit. For example, you can ask Assistant to "add properties to change the colors of the cabin."

It's also helpful to define how different parts of the model should respond to changes in scale or count. For example, you can say "when I scale the table longer or wider, the model should add more chairs proportionally." You can even include specific technical details, like measurements of spacing between parts, like "add a property to control the distance between the rails of the railroad."

Reference images for procedural models

When uploading images for procedural model generation, use .png images. Choose images with good lighting, a clear focus on the object of interest, and a simple background. When possible, use images with good spatial information, like isometric or 3/4 angles, instead of direct front, side, or back views. Avoid low-poly style images.

For objects that can't be fully captured from a single angle, you can include multiple viewpoints in a single image to improve the accuracy of the procedural model generation.

Keep trying

Don't get discouraged if Assistant doesn't work exactly the way you want the first time. Often, making small tweaks and trying again can lead to better results. Many AI tools are non-deterministic, meaning they don't create the exact same output each time you ask them to do something. There's some variance, which you can tap into and control using tweaks to your prompt.

AI in its current state requires work. It takes time to understand how to best speak to Assistant, what it can do, and how to get what you want out of it.

Examples

These examples demonstrate the vast variety of tasks that Assistant can help with today. Some of them might take a few tries for you to reproduce, but give them a try and see what you can come up with yourself.

Game mechanics - Shoot fireballs that explode

Prompt: Propel a fireball away from the player in the direction the player is facing when the player presses "e". Make the fireball explode when it hits something.

Game mechanics - Set up a teams system and assign players

Prompt: Add a script to make a system of teams (red, blue, green, yellow) and assign each player randomly to a team.