Retorna um objeto `Datatype.OverlapParams` em branco. Ao contrário de outros
construtores de tipos de dados, este construtor não possui parâmetros, portanto,
você deve definir suas propriedades adequadamente.

OverlapParams.new

Retorna um objeto `Datatype.OverlapParams` em branco.

O tipo de dado `Datatype.OverlapParams` armazena parâmetros para uso com
as funções de consulta de limites de `Class.WorldRoot`, em particular
`Class.WorldRoot:GetPartBoundsInBox()`,
`Class.WorldRoot:GetPartBoundsInRadius()` e
`Class.WorldRoot:GetPartsInPart()`. As propriedades
`Datatype.OverlapParams.ExcludeInstances|ExcludeInstances` e
`Datatype.OverlapParams.IncludeInstances|IncludeInstances` armazenam um
conjunto de objetos e seus descendentes que serão excluídos e incluídos da
consulta. A propriedade `Datatype.OverlapParams.CollisionGroup` pode especificar um
grupo de colisão para a operação de consulta de limites.

Ao contrário da maioria dos tipos de dados no Luau, você pode alterar todos os
membros de `Datatype.OverlapParams` sem criar um novo objeto, permitindo que você
reuse o mesmo objeto repetidamente.

Adiciona as instâncias fornecidas a
`Datatype.OverlapParams.FilterDescendantsInstances|FilterDescendantsInstances`.
Observe que essa propriedade foi substituída por
`Datatype.OverlapParams.ExcludeInstances|ExcludeInstances` e
`Datatype.OverlapParams.IncludeInstances|IncludeInstances`, que devem ser
usadas para novos trabalhos.


OverlapParams:AddToFilter

instances

Uma instância ou um array contendo instâncias a serem adicionadas.

Adiciona as instâncias fornecidas a
`Datatype.OverlapParams.FilterDescendantsInstances|FilterDescendantsInstances`.

OverlapParams

Uma matriz opcional de instâncias cujos descendentes serão excluídos da
consulta. Essa propriedade pode ser usada simultaneamente com
`Datatype.OverlapParams.IncludeInstances|IncludeInstances` para permitir
filtragem mista, por exemplo, incluindo uma grande pasta, mas excluindo
instâncias filhas específicas. Se uma instância corresponder a um filtro de
exclusão e inclusão, as exclusões têm prioridade sobre as inclusões.


OverlapParams.ExcludeInstances

Um array opcional de instâncias cujos descendentes serão excluídos da
consulta.

Uma matriz opcional de instâncias cujos descendentes serão incluídos na
consulta. Essa propriedade pode ser usada simultaneamente com
`Datatype.OverlapParams.ExcludeInstances|ExcludeInstances` para permitir
filtragem mista. Se uma instância corresponder a um filtro de
exclusão e inclusão, as exclusões têm prioridade sobre as inclusões.

Definir `IncludeInstances` como `nil` em vez de uma matriz vazia (`{}`) tem
efeitos opostos. `IncludeInstances = nil` é o filtro mais permissivo
(inclui tudo), enquanto `IncludeInstances = {}` é o filtro mais
restritivo (não inclui nada).


OverlapParams.IncludeInstances

Um array opcional de instâncias cujos descendentes serão incluídos na
consulta.

A quantidade máxima de partes a serem retornadas pela consulta. O valor
padrão de zero (`0`) representa sem limite.

OverlapParams.MaxParts

A quantidade máxima de partes a serem retornadas pela consulta.

Especifica um grupo de colisão para a operação. Partes em grupos de colisão
que estão configurados para **não** colidir com este grupo são ignoradas. Se esta
propriedade for omitida, a operação assume o grupo de colisão **Default**.

OverlapParams.CollisionGroup

O grupo de colisão usado para a operação.

Aumenta ligeiramente o volume da operação de consulta de limites, limitado
entre `0` e `0.05` studs.

OverlapParams.Tolerance

Aumenta ligeiramente o volume da operação de consulta de limites.

Esta propriedade, se `true`, faz com que a operação de consulta de limites use um
valor `Class.BasePart.CanCollide` da parte intersectada em favor de seu valor
`Class.BasePart.CanQuery` ao determinar se essa parte está incluída na lista de
resultados da consulta espacial.

OverlapParams.RespectCanCollide

Determina se a operação de consulta de limites considera o valor da
propriedade `Class.BasePart.CanCollide` de uma parte em vez de seu
valor `Class.BasePart.CanQuery`.

Quando habilitado, a consulta ignorará todas as propriedades de colisão de
partes e realizará uma verificação de força bruta em cada parte. Isso afetará
negativamente o desempenho e não deve ser usado em experiências ao vivo.

OverlapParams.BruteForceAllSlow

Quando habilitado, a consulta ignorará todas as propriedades de colisão de
partes e realizará uma verificação de força bruta em cada parte.

Uma matriz de objetos cujos descendentes são usados na filtragem de
desafetores. Observe que essa propriedade foi substituída por
`Datatype.OverlapParams.ExcludeInstances|ExcludeInstances` e
`Datatype.OverlapParams.IncludeInstances|IncludeInstances`, que devem ser
usadas para novos trabalhos.


OverlapParams.FilterDescendantsInstances

Um array de objetos cujos descendentes são usados na filtragem de candidatos.

Determina se a
`Datatype.OverlapParams.FilterDescendantsInstances|FilterDescendantsInstances`
matriz é usada como uma lista de exclusão ou inclusão. Observe que essa
propriedade foi substituída por
`Datatype.OverlapParams.ExcludeInstances|ExcludeInstances` e
`Datatype.OverlapParams.IncludeInstances|IncludeInstances`, que devem ser
usadas para novos trabalhos.


OverlapParams.FilterType

Determina se o
array `Datatype.OverlapParams.FilterDescendantsInstances|FilterDescendantsInstances`
é usado como uma lista de exclusão ou inclusão.

Armazena parâmetros usados em funções de consulta de limites.

/reference/engine/datatypes/OverlapParams.yaml

Luau

{any}

Data Type

Instance

Um objeto que executa funções conectadas ao ocorrer um evento específico.

RBXScriptSignal

Usado em um objeto `Datatype.RaycastParams` para determinar como sua lista `Datatype.RaycastParams.FilterDescendantsInstances|FilterDescendantsInstances` será usada.

Enum

Enum.RaycastFilterType

Tipo de dado que tem um valor de verdadeiro ou falso.

boolean

Um número em ponto flutuante de dupla precisão.

number

Uma sequência de caracteres, como letras, números e símbolos.

string

Experiências

Avatar

Ativos

Amostras e projetos

API de motor

API de nuvem aberta

Studio

Dados analíticos

Plataforma

Tutoriais

Programas de Criador

Educação

Cursos

Aprender

Este método é assíncrono e retorna uma "Operação", que representa o estado atual da operação. Ele contém um caminho de endpoint que você pode solicitar para obter a resposta real e os metadados aplicáveis. Veja o [documentation]({longRunningOperationsLink}) em operações de longo prazo para obter mais informações.
            
As seções a seguir descrevem os objetos de resposta e metadados que são fornecidos quando uma operação se completa.

Pontos de extremidade beta estão prontos para uso público. Alterações  danosas são possíveis mas raras.

Estas páginas de documentação do Open Cloud serão removidas em 31 de março de 2026. A partir dessa data, vamos redirecionar você automaticamente para a nova documentação do Open Cloud. {linkStart}Saiba mais{linkEnd}.

Estas páginas antigas da Open Cloud serão removidas e redirecionadas em 31 de março de 2026. {linkStart}Saiba mais{linkEnd}.

Os endpoints experimentais estão prontos para uso público, mas podem sofrer alterações ocasionais à medida que o contrato da API é finalizado.

Este endpoint pode ser chamado na experiência por meio do {httpServiceLinkStart}HttpService{httpServiceLinkEnd} com uma chave API.

Este campo pode ser definido ao criar um recurso, mas não pode ser modificado por solicitações subsequentes.

Esses campos podem ser definidos ao criar um recurso, mas não podem ser modificados por solicitações subsequentes.

Este campo pode ser fornecido em solicitações, mas nunca será incluído em respostas.

Método de autenticação legado. Sempre prefira usar a chave API ou OAuth 2.0 quando disponível.

Por chave de API: {maxInPeriod} solicitações a cada {periodInSeconds} segundos por endereço IP

Não requer autenticação para ser chamado. Costuma ter limites de taxa significativamente reduzidos. Sempre prefira usar a chave API ou OAuth 2.0 quando disponível.

Para cada agrupamento, apenas um dos seguintes campos no esquema deve ser fornecido; o restante pode ser excluído.

Você pode voltar a qualquer momento. {linkStart}Deixe um comentário.{linkEnd}

Você está visualizando os documentos antigos. {linkStart}Deixe um comentário.{linkEnd}

Você pode desativar a qualquer momento e seguir de volta para as páginas de referência antigas. {linkStart}Deixe um comentário.{linkEnd}

Você está visualizando os documentos renovados. {linkStart}Deixe um comentário.{linkEnd}

Este campo pode ser definido como respostas, mas será ignorado em solicitações.

Nota: Os limites de taxa podem ser menores durante períodos de alto tráfego. Alguns pontos de extremidade têm limites de taxa adicionais. [Saiba mais sobre os limites da taxa]({link}).

{limit} solicitações por segundo em todas as chaves API para um usuário ou grupo

{limit} solicitações por hora em todas as chaves API para um usuário ou grupo

{limit} solicitações por segundo em todas as chaves de API para um usuário ou grupo

{limit} solicitações por minuto por proprietário de chave API

{limit} solicitações por dia por usuário do aplicativo

{limit} solicitações por hora por usuário do aplicativo

{limit} solicitações por minuto por usuário do aplicativo

{limit} solicitações por segundo por usuário do aplicativo

{limit} solicitações por segundo por proprietário de chave API

Escopos controlam quais permissões suas credenciais tem. Suas credenciais só podem acessar os endpoints suportados pelos escopos selecionados.

Os endpoints estáveis estão prontos para uso em produção e quase nunca sofrerão alterações significativas durante sua vida útil.

Este alvo permite limitar o acesso da chave às {requiredParts} selecionadas

Este alvo permite limitar o acesso da chave aos {requiredParts} selecionados e {optionalParts}

Os tipos de destino são usados para restringir os recursos para os quais suas credenciais têm permissões. Apenas os recursos selecionados podem ser acionados, mesmo que sua conta tenha permissões para recursos adicionais. Alguns escopos não têm partes de destino. Nesses casos, todos os seus recursos relevantes podem ser acionados.

A parte de nível superior do universo não precisa ser selecionada para chaves API que pertencem ao usuário. Nesse caso, sua chave API terá acesso a todas as suas experiências que pertencem ao usuário ou ao grupo para as quais você tem as permissões de grupo corretas.

A função Try It Out ainda não é suportada com endpoints que exigem chave API ou autenticação OAuth 2.0

Por segurança, a autenticação de cookies está desabilitada para operações de alto risco.

Os endpoints de risco crítico são extremamente sensíveis, por isso, a função Try It Out está desativada por motivos de segurança

Observação: este exemplo de código não inclui cabeçalhos de autenticação. Pode ser necessário adicionar um cabeçalho de autenticação para que este comando funcione.

Este é um endpoint de alto risco que pode modificar ou excluir dados críticos. Tenha muito cuidado ao testar.

Este endpoint de API foi classificado como ALTO RISCO e pode afetar dados em operação ou contas de usuário.

Solicitações autenticadas para APIs de alto risco podem resultar em alterações que não podem ser desfeitas. Revise os parâmetros da sua solicitação cuidadosamente antes de prosseguir.

Entre na sua conta para usar a autenticação de cookies

Este é um endpoint de baixo risco que recupera dados. Geralmente, é seguro para testes.

Este é um endpoint de risco médio que modifica dados. Teste com cuidado com contas que não tenham grande importância, pois as alterações podem ser permanentes.

Para manter sua conta segura, nunca cole texto de outras fontes aqui ou envie informações desta página para outras pessoas.

Você está prestes a testar endpoints de API em operação usando suas credenciais de conta reais.

Prossiga apenas se você estiver ciente das consequências das chamadas de API que você está prestes a fazer. Revise a documentação da API cuidadosamente antes de fazer os testes.

As chamadas de API serão feitas usando sua sessão autenticada

Essas chamadas de API são reais e podem afetar sua conta ou dados

Limites de taxa e outras restrições de API se aplicam

Algumas ações podem modificar ou excluir dados

Este endpoint foi substituído por estes endpoints alternativos recomendados:

Os seguintes escopos são necessários para chamar este endpoint. Para mais
informações sobre como gerar chaves adequadas, consulte [Gerenciar chaves API]({apiKeyReferenceDocLink}).

Para mais informações sobre como gerar chaves, consulte [Gerenciar chaves de API]({apiKeyReferenceDocLink}).

Os seguintes endpoints estão disponíveis em caminhos relativos à URL base.

Esta cadeia de caracteres está formatada como um [FieldMask](/cloud/reference/types#fieldmask).

Um valor JSON pode ser `null`, `boolean`, `string`, `number`, `array`, ou `object`.

Os seguintes escopos são necessários para que seu aplicativo OAuth 2.0 use este endpoint. Para obter mais informações sobre como registrar um aplicativo OAuth 2.0, consulte [Registro e revisão de aplicativos]({oauth2ReferenceDocLink}).

Para mais informações sobre como registrar um aplicativo OAuth 2.0, consulte [Registro e revisão de aplicativos]({oauth2ReferenceDocLink}).

Os seguintes objetos descrevem payloads que são aceitos ou retornados. Veja cada endpoint para mais informações sobre quando esses objetos são usados.

Os seguintes escopos são necessários para chamar este endpoint.

Caminhos de recursos

Esta cadeia de caracteres é formatada como um [Timestamp](/cloud/reference/types#timestamp).

Os seguintes escopos são necessários para que sua aplicação OAuth 2.0 use este endpoint. Para obter mais informações sobre como registrar um aplicativo OAuth 2.0, consulte [Registro e revisão do aplicativo]({oauth2ReferenceDocLink}).

Não recomendado

Você está visualizando a referência renovada do Open Cloud.

Você optou por não participar da nova referência do Open Cloud.

Ver suas contas de faturamento de publicidade.

Ver suas campanhas de anúncios e o desempenho delas.

Crie, atualize e gerencie suas campanhas de anúncios.

Isto permite visualizar informações sobre seus ativos.

Isto permite enviar e atualizar ativos para a Roblox.

Isso permite visualizar as permissões de ativos de elementos (incluindo grupos e experiências) e ativos que sua conta tem acesso.

Isso permite conceder permissões de ativos a todos os participantes (incluindo grupos e experiências) e aos ativos que sua conta tem acesso.

Isso permite que você visualize o status e os resultados de tarefas de configuração automática de avatar em seu nome.

Isso permite que você crie e gerencie tarefas de configuração automática de avatar em seu nome.

Concede a capacidade de atualizar emblemas de propriedade do usuário.

Isso permite visualizar informações sobre seus itens de comércio.

Isso permite fazer alterações nos itens de comércio sincronizados.

Isto permite visualizar informações sobre suas conexões de comerciante.

Isso permite editar suas conexões de comerciante.

Isso permite que você visualize informações sobre seus produtos da Loja do Criador.

Isso permite que você modifique informações sobre seus produtos da Loja de Criadores.

Isso permite que você veja informações dos elementos que salvou da Loja do Criador.

Isso permite que você modifique informações dos elementos que salvou da Loja do Criador.

Concede acesso à criação de armazenamento de dados em seu nome.

Concede acesso para excluir armazenamentos de dados em seu nome.

Concede acesso para ler uma lista de armazenamento de dados.

Concede acesso para tirar uma captura de seu armazenamento de dados.

Concede acesso para criar entradas em seu armazenamento de dados.

Concede acesso para marcar entradas especificadas para exclusão.

Concede acesso à lista de entradas de seu armazenamento de dados.

Concede acesso a entradas especificadas em seu armazenamento de dados.

Concede acesso para atualizar o valor, atributos e usuários de uma entrada.

Concede acesso para excluir revisões de entradas de seu armazenamento de dados.

Concede acesso a revisões de lista de entradas de seu armazenamento de dados.

Concede acesso para ver os detalhes da configuração dos produtos do desenvolvedor do usuário autorizado.

Concede acesso para editar os produtos do desenvolvedor do usuário autorizado.

Isto permite visualizar informações sobre os ambientes do seu universo.

Isto permite editar os ambientes do seu universo.

Concede acesso para ver os detalhes da configuração dos passes de jogo do usuário autorizado.

Concede acesso para editar os passes de jogo do usuário autorizado.

Concede acesso para ver as informações dos fóruns da comunidade para sua conta.

Concede acesso para gerenciar as informações dos fóruns da comunidade para sua conta.

Isso permite visualizar informações sobre suas comunidades

Isso permite que você gerencie solicitações de participação na comunidade e atualizações de cargos de membros da comunidade de níveis inferiores para sua conta.

Permite que você veja os dados da instância de propriedade.

Permite modificar os dados de propriedade de instâncias (atualmente suporta apenas scripts).

Isto permite visualizar informações sobre seu inventário.

Conceda acesso para gerenciar seus ativos.

Concede acesso para gerenciar seus emblemas.

Concede acesso para gerenciar seus emblemas e gastar Robux.

Concede acesso para atualizar os emblemas do usuário autorizado.

Concede acesso para gerenciar seus produtos de desenvolvedor.

Concede acesso para ler informações sobre as experiências nas quais você tem notificações ligadas.

Concede acesso às notificações para as experiências em seu nome.

Concede acesso para gerenciar seus passes.

Concede acesso para gerenciar suas comunidades.

Concede permissão para ler informações da comunidade.

Concede permissões de gerenciamento de comunidade.

Concede acesso para ler e escrever suas tabelas de localização

Concede acesso para gerenciar a colaboração de equipe para todas as experiências que você possui.

Concede acesso para gerenciar suas experiências e certas informações associadas a suas experiências (por exemplo, informações de localização).

Concede acesso para ler as informações de localização das suas experiências.

Concede acesso para modificar as preferências de localização das suas experiências.

Concede acesso para gerenciar sua conta de usuário.

Concede acesso para modificar as preferências de localização do usuário.

Permite que você veja o status, registros e resultados de tarefas de execução Luau para o local associado.

Permite criar novas tarefas de execução Luau para o lugar associado.

Concede acesso a liberar assíncronamente todas as estruturas de dados no universo.

Concede acesso para criar novos itens da fila.

Concede acesso para descartar itens lidos do começo da fila.

Concede acesso para ler itens no começo da fila.

Concede acesso para ler os itens do armazenamento de memória.

Concede acesso para criar, atualizar e excluir itens de mapa.

Isto permite publicar mensagens em nome de um usuário.

Isto permite o envio de notificações da sua experiência aos usuários.

(Obsoleto) Concede acesso para ler uma lista de entradas em um armazenamento de dados ordenado.

(Obsoleto) Concede acesso para criar uma nova entrada em um armazenamento de dados ordenado.

Concede acesso a entradas de lista de um armazenamento de dados ordenado.

Concede acesso para criar entradas em um armazenamento de dados ordenado.

Isto permite listar segredos aliados à sua experiência.

Isto permite criar e atualizar segredos relacionados à sua experiência.

Esta permissão permite que você envie um trabalho de avaliação e visualize o resultado da tarefa.

Concede acesso para ler sobre seus produtos de assinatura.

Isso permite que você leia informações de miniaturas em seu nome.

Concede a capacidade de ler dados analíticos do jogo.

Concede a capacidade de ler informações do local.

Concede a capacidade de editar as informações do local.

Concede acesso para publicar novas versões de experiências na Roblox.

Concede a capacidade de ler informações da experiência.

Concede acesso para editar as experiências do usuário autorizado.

Permite que você veja restrições de usuário na experiência.

Permite que você edite restrições de usuário na experiência.

Isso permite ver as notificações enviadas para sua conta.

Concede a capacidade de ler o status premium e verificado do usuário autorizado.

Isso permite que você veja as contas sociais do usuário autorizado.

Isto habilita a funcionalidade de entrada única.

Isso permite acesso à leitura das informações do seu perfil.