Os Templates de Entidade são o sistema de entidades reutilizáveis do Cave.

Eles permitem que você construa uma configuração de entidade uma vez, salve-a como um ativo e coloque instâncias dela em várias cenas.

Se você vem de outra engine, pode pensar nos Templates de Entidade como o fluxo de trabalho semelhante a prefab do Cave. Se você é novo em engines de jogo, pense neles como receitas de objetos reutilizáveis.

Em vez de reconstruir a mesma porta, inimigo, item ou widget de UI toda vez, você cria a configuração uma vez e a reutiliza sempre que precisar.

O Que São Templates de Entidade?

Um Template de Entidade é um ativo que armazena uma estrutura de entidade.

Ele pode incluir:

Uma entidade raiz (todo Template DEVE ter uma e apenas uma Entidade Raiz).
Entidades filhas.
Componentes.
Configurações de componentes.
Referências a ativos.
Propriedades.
Tags.

Quando você coloca um template em uma cena, o Cave cria uma instância desse template.

A instância usa o ativo template como sua base, o que significa que pode manter a mesma estrutura interna, enquanto ainda existe como um objeto colocado em uma cena específica.

Por Que os Templates de Entidade São Importantes

Muitos objetos de jogo não são apenas uma malha.

Um item pode incluir:

Um modelo visível.
Um gatilho.
Uma luz.
Um efeito de partícula.
Um som.
Lógica que fornece a recompensa.

Um template permite que você mantenha toda essa configuração junta.

Use Templates de Entidade para coisas como:

Personagens players.
Inimigos.
Itens.
Portas.
Balas.
Veículos.
Portais.
Volumes de dano.
Props.
Peças de UI.
Objetos de jogabilidade reutilizáveis.

Templates economizam tempo, mas também mantêm objetos repetidos consistentes. Se cada item de saúde vem do mesmo template, você pode melhorar o template uma vez e manter o projeto organizado.

Criando um Template de Entidade

Você pode criar um Template de Entidade a partir do Navegador de Ativos, ou pode promover uma entidade de cena existente a um template clicando com o botão direito nela no Gráfico de Cena ou pressionando Ctrl + T para promover a selecionada.

Um fluxo de trabalho comum é construir o objeto diretamente em uma cena primeiro, testá-lo e só transformá-lo em um template uma vez que a configuração seja útil. Isso se parece com:

Construa uma entidade em uma cena.
Adicione os componentes e filhos que ela precisa.
Ajuste suas configurações.
Promova-a a um Template de Entidade.
Reuse esse template na mesma cena ou em outras cenas.

Mas assim que você tiver certeza de que reutilizará algo, como o jogador, inimigos, power-ups, etc., é uma boa prática criá-lo imediatamente, seja no navegador de ativos ou promovendo-o como sugerido antes.

No Gráfico de Cena, o menu de edição rápida pode promover uma entidade a um template. O atalho mostrado pelo editor é Ctrl + T.

Ativo de Template vs Instância de Template

Ajuda separar o ativo de template da instância colocada.

Conceito	Significado
Ativo de template	A configuração de objeto reutilizável armazenada no Navegador de Ativos.
Instância de template	Uma cópia colocada desse template dentro de uma cena.

O ativo define a estrutura reutilizável.

A instância é onde essa estrutura reutilizável aparece em uma cena específica.

Editando um Template de Entidade

Templates são editados como seu próprio ativo.

Quando você abre um template para edição, o Cave muda para uma cena de edição de template para que você possa editar a estrutura interna da entidade do template diretamente.

A ideia importante é:

> O template possui sua própria hierarquia interna.

As instâncias de cena usam essa hierarquia, mas não possuem diretamente cada filho dentro dela. Isso mantém todas as instâncias conectadas à mesma configuração reutilizável.

Vale a pena mencionar que isso deixa de ser verdade assim que o jogo começa, porque quando você inicia o jogo, toda a hierarquia do template está imediatamente disponível para você personalizar. Portanto, ao programar sua lógica de jogo, você pode esperar interagir com a instância do template de entidade, filhos, etc.

Por exemplo, se você abrir um template de Inimigo e adicionar um novo filho Barra de Vida dentro dele, cada instância desse template de inimigo pode se beneficiar da estrutura atualizada.

Por Que os Filhos de Template Não São Editados Diretamente na Cena

Quando uma instância de template é colocada em uma cena, os filhos internos ainda pertencem ao template. É por isso que o Cave protege os filhos do template de edições diretas na cena.

Por exemplo, se um template de inimigo contém:

Inimigo
  Malha do Corpo
  Área de Detecção
  Barra de Vida

Você deve editar esses filhos internos dentro do template, e não como objetos separados pertencentes à cena.

Isso mantém cada instância consistente. Se cada inimigo colocado pudesse editar livremente seus filhos internos, o template deixaria de ser um objeto reutilizável confiável.

Instanciando um Template em uma Cena

Depois que um template existe, você pode colocá-lo em uma cena.

Por exemplo, você pode arrastar um template do Navegador de Ativos para a Visualização 3D.

Quando o template é colocado:

Ele aparece no Gráfico de Cena como uma instância de template.
O Cave usa uma cor de template diferente (verde) para a instância.
A instância mantém sua conexão com o ativo template.

Do ponto de vista do fluxo de trabalho, esta é uma das maneiras mais rápidas de construir níveis. Você cria uma porta reutilizável, item, inimigo ou prop uma vez, e depois coloca instâncias onde o nível precisa delas.

Personalização Local de Template

As instâncias de template ainda podem ser personalizadas localmente:

A principal maneira de fazer isso é através das propriedades expostas pela entidade raiz do template.

Isso lhe dá um equilíbrio útil:

A estrutura permanece reutilizável.
Cada instância colocada pode ter seus próprios valores.

Por exemplo, múltiplos inimigos podem usar o mesmo template de inimigo, enquanto cada instância tem diferentes saúde, velocidade, configurações de patrulha ou opções de comportamento.

Exemplos de Propriedades Locais de Template

Propriedades locais úteis incluem:

Propriedade	Exemplo de Uso
Saúde do inimigo	Tornar um inimigo mais fraco ou mais forte.
Velocidade do inimigo	Criar variantes lentas e rápidas.
Quantidade de dano	Reutilizar uma configuração de perigo com diferentes níveis de perigo.
Nível alvo do portal	Enviar cada portal para uma cena diferente.
Valor do pickup	Fazer moedas, gemas ou recompensas valerem quantidades diferentes.
Estado de bloqueio da porta	Reutilizar uma configuração de porta para portas bloqueadas e desbloqueadas.
Texto da UI	Reutilizar um widget de UI com rótulos diferentes.

Por exemplo, um template de Portal pode ser usado em muitos lugares se cada portal colocado tiver uma propriedade local que escolhe a cena alvo.

Exemplos de Templates de Projetos Iniciais

Projetos iniciais podem incluir vários templates úteis, dependendo das opções de projeto que você selecionou.

Você pode encontrar exemplos como:

Template de jogador.
Template de inimigo.
Template de dano.
Template de portal.
Template de veículo.
Peças reutilizáveis de jogabilidade.

Esses valem a pena serem inspecionados. Abra-os, olhe para a hierarquia, inspecione os componentes e veja quais propriedades estão expostas.

O conteúdo gerado não está apenas lá para ser usado. Também está lá para te ensinar como objetos reais do Cave podem ser construídos.

Bons Casos de Uso para Templates de Entidade

Crie um template quando um objeto é:

Repetido muitas vezes.
Usado em várias cenas.
Construído a partir de múltiplos componentes.
Construído a partir de múltiplas entidades filhas.
Destinado a se comportar de maneira consistente.
Útil como uma peça reutilizável de jogabilidade.

Bons candidatos incluem:

Inimigos.
NPCs.
Armas.
Balas.
Coletáveis.
Portas.
Pontos de verificação.
Armadilhas.
Portais de nível.
Veículos.
Props destrutíveis.
Widgets de UI.
Peças reutilizáveis de design de nível.

Quanto mais você reutiliza um objeto, mais valioso um template se torna.

Quando Não Usar um Template

Nem tudo precisa ser um template.

Um objeto único que aparece uma vez e só faz sentido em uma cena pode permanecer como uma entidade de cena normal.

Por exemplo:

Um prop de cinema único.
Um gatilho específico de nível especial.
Uma decoração única que nunca será reutilizada.
Um objeto de teste temporário.

Templates são poderosos, mas são mais úteis quando a reutilização realmente importa. Transformar cada pequeno objeto em um template muito cedo pode dificultar a gestão do projeto, não torná-lo mais fácil.

Uma Regra Simples de Template

Se você se pegar copiando a mesma configuração de entidade mais de uma vez, considere torná-la em um Template de Entidade.

Esse único hábito pode economizar muito tempo e manter seu projeto muito mais limpo à medida que cresce.

Cave: Guia de Introdução

Modelos de Entidade

Keep your place in this quest