Ferramentas de editor do Unity: torne edições de propriedades desfazíveis e preserve overrides de prefab

Trate uma ação do editor como uma alteração autoral

Uma boa ferramenta de editor precisa responder com clareza o que o usuário alterou e qual objeto é dono dessa alteração. Atualizar a exibição do Inspector, alterar o estado serializado, criar uma entrada de Undo e salvar um arquivo são responsabilidades diferentes. Defina o alvo da ação e o resultado esperado antes de adicionar um botão de conveniência. O comportamento da API descrito aqui segue as referências citadas do Unity 6.0. [1][2][3]

Prefira o fluxo de propriedades serializadas

SerializedObject e SerializedProperty oferecem um fluxo de edição para campos serializados e integram as alterações ao Undo e aos overrides de prefab. Num fluxo mantido ao longo do tempo, chame Update antes de ler valores atualizados, modifique as propriedades desejadas e grave as alterações com ApplyModifiedProperties. Fluxos separados que tenham os mesmos objetos como alvo exigem sincronização. [1]

Mantenha a mutação atrelada à ação real do usuário. Desenhar o Inspector repetidamente não deve, por si só, continuar alterando valores autorais. Valide também os dados de forma deliberada: aplicar campos serializados não executa a lógica de validação do setter de uma propriedade C# associada. [1]

Torne previsível uma ferramenta concreta de launcher

Imagine um componente launcher com um campo serializado launchSpeed. Um botão define os launchers selecionados, a partir dos valores atuais, para 9 unidades de projeto por segundo. Uma instância específica de prefab na cena tinha antes o valor 6. O resultado pretendido é um override na instância que possa ser desfeito até o valor anterior, enquanto o prefab de origem mantém o padrão que já tinha.

Deixe explícito o escopo do botão. Definir todos os launchers selecionados com o mesmo valor é diferente de somar uma quantidade relativa ao valor existente de cada launcher. O getter de uma propriedade serializada com vários objetos retorna o valor do primeiro alvo; portanto, lê-lo uma vez e aplicar a aritmética a todos os alvos não implementaria ajustes relativos independentes. [1]

Registre as mutações diretas na ordem correta

Se a ferramenta altera diretamente as propriedades dos objetos, chame Undo.RecordObject no objeto que será modificado antes de atribuir os novos valores. No caso de uma instância de prefab, chame depois PrefabUtility.RecordPrefabInstancePropertyModifications, após a modificação, para que o override seja registrado. O Unity recomenda o fluxo serializado quando ele se adequa à edição. [2][3]

Registre o componente ou objeto que de fato é o dono da propriedade, e não um wrapper de seleção sem relação. Essa API de registro de propriedades não cobre a mudança do pai de um transform, a adição de um componente nem a destruição de um objeto; essas operações exigem as funções de Undo específicas. Não estenda um editor escalar que já funciona partindo do princípio de que toda operação estrutural tem o mesmo contrato de registro. [2]

Verifique Undo e persistência separadamente

No exemplo do launcher, confira o valor alterado, o Undo, o Redo e o override de prefab visível. Salve e reabra a cena para inspecionar o resultado persistido, e inspecione o prefab de origem para confirmar o escopo pretendido. Repita o teste com vários objetos selecionados que tenham valores iniciais diferentes.

Essas verificações respondem a perguntas distintas: se a edição aconteceu, se o estado anterior pode ser recuperado e se o estado autoral pretendido sobrevive à reabertura. A verificação proposta não foi executada aqui. Mantenha alterações em arquivos externos e outros efeitos colaterais não serializados fora do que se presume que um registro de Undo de propriedade comum consiga restaurar.

Fontes

1. SerializedObject — Unity Technologies.
2. Undo.RecordObject — Unity Technologies.
3. PrefabUtility.RecordPrefabInstancePropertyModifications — Unity Technologies.