Version: Unity 6.7 Alpha (6000.7)
LanguageEnglish
  • C#

AndroidProjectFiles.SetFileContents

Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

Declaration

public void SetFileContents(string path, string contents);

Parameters

Parameter Description
path The file to write to. This path is relative to the Gradle project path.
contents The string content to write to the file. Unity encodes the string as UTF-8 when it writes the file.

Description

Sets the content of a new file to the specified string.

To use this method, you must first declare the new file in AndroidProjectFilesModifier.Setup using the AndroidProjectFilesModifierContext.AdditionalOutputs.AddFileWithContents method.

The following example declares a new text file in the Setup method and writes string content to it during the build.

using UnityEditor.Android;

public class ModifyProjectScript : AndroidProjectFilesModifier { // Configure the required settings/outputs to modify the Android project files. public override AndroidProjectFilesModifierContext Setup() { var projectFilesContext = new AndroidProjectFilesModifierContext();

// Declare the new file. projectFilesContext.Outputs.AddFileWithContents("AdditionalContent/ModifyProjectTextFile.txt");

return projectFilesContext; }

// Modify the Android project files. public override void OnModifyAndroidProjectFiles(AndroidProjectFiles projectFiles) { // Set the file contents. This requires the file to be added to the outputs in the Setup method. projectFiles.SetFileContents("AdditionalContent/ModifyProjectTextFile.txt", "This was created in the OnModifyAndroidProjectFiles method"); } }

Declaration

public void SetFileContents(string path, byte[] contents);

Parameters

Parameter Description
path The file to write to. This path is relative to the Gradle project path.
contents The byte array content to write to the file.

Description

Sets the content of a new file to the specified bytes.

To use this method, you must first declare the new file in AndroidProjectFilesModifier.Setup using the AndroidProjectFilesModifierContext.AdditionalOutputs.AddFileWithContents method.

The following example declares a new file in the Setup method and writes byte array content to it during the build.

using UnityEditor.Android;

public class ModifyProjectScript : AndroidProjectFilesModifier { // Configure the required settings/outputs to modify the Android project files. public override AndroidProjectFilesModifierContext Setup() { var projectFilesContext = new AndroidProjectFilesModifierContext();

// Declare the new file. projectFilesContext.Outputs.AddFileWithContents("AdditionalContent/ModifyProjectBinaryFile.bin");

return projectFilesContext; }

// Modify the Android project files. public override void OnModifyAndroidProjectFiles(AndroidProjectFiles projectFiles) { // Set the file contents. This requires the file to be added to the outputs in the Setup method. byte[] contents = new byte[] { 0x01, 0x02, 0x03, 0x04 }; projectFiles.SetFileContents("AdditionalContent/ModifyProjectBinaryFile.bin", contents); } }