Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseStores the paths to the Roslyn Analyzer additional files.
It is possible to add to the project a list of additional files that can be used by your Roslyn Analyzer/SourceGenerator.
The Unity Editor evaluates files with the .additionalfile extension to test if they're suitable to pass into the compilation pipeline.
Files whose names match the Filename.[Analyzer Name].additionalfile format are suitable and Unity passes them to the compilation pipeline.
If the file isn't named with the [Analyzer Name] suffix, Unity still imports it but doesn't pass it to the compilation pipeline.
Note: For Unity to correctly recognize the format, the [Analyzer Name] must match the name of the analyzer the file targets and the Filename prefix must not contain a "." character. The [Analyzer Name] suffix is case-sensitive.
Each compiled assembly receives a list of additional files based on the analyzers running for that assembly definition, filtered by the [Analyzer Name] suffix. The following example shows which additionalfiles Unity passes on for three assemblies with either or both of two analyzers:
Assembly1 uses an analyzer named Analyzer1
Assembly2 uses an analyzer named Analyzer2
Assembly3 uses both Analyzer1 and Analyzer2
If the project contains four additional files named FileA.Analyzer1.additionalfile, FileB.Analyzer2.additionalfile, FileC.additionalfile, and FileD.Analyzer3.additionalfile,
then Unity passes the following list of additional files with the respective assemblies:
Assembly1: FileA.Analyzer1.additionalfile
Assembly2: FileB.Analyzer2.additionalfile
Assembly3: FileA.Analyzer1.additionalfile, FileB.Analyzer2.additionalfile
Since FileC doesn't use an [Analyzer Name] suffix and FileD references an analyzer that isn't present in the project, Unity doesn't pass either one to the compilation pipeline.
The full list of additional files added to the assembly compilation can then be retrieved by the analyzers from the analyzer context.
It is important to note that this list comprises all the additional files added to the compilation, not only the ones matching the name of the analyzers.
For Assembly3 in the above example, Analyzer1 and Analyzer2 both retrieve the correctly named additional files that references them.
The analyzer is responsible for checking if there is any data it can use.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.