This page has been translated automatically.
Видеоуроки
Интерфейс
Основы
Продвинутый уровень
Подсказки и советы
Основы
Программирование на C#
Рендеринг
Профессиональный уровень (SIM)
Принципы работы
Свойства (properties)
Компонентная Система
Рендер
Физика
Редактор UnigineEditor
Обзор интерфейса
Работа с ассетами
Контроль версий
Настройки и предпочтения
Работа с проектами
Настройка параметров ноды
Setting Up Materials
Настройка свойств
Освещение
Sandworm
Использование инструментов редактора для конкретных задач
Расширение функционала редактора
Встроенные объекты
Ноды (Nodes)
Объекты (Objects)
Эффекты
Декали
Источники света
Geodetics
World-ноды
Звуковые объекты
Объекты поиска пути
Player-ноды
Программирование
Основы
Настройка среды разработки
Примеры использования
C++
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Плагины
Форматы файлов
Материалы и шейдеры
Rebuilding the Engine Tools
Интерфейс пользователя (GUI)
Двойная точность координат
API
Animations-Related Classes
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
Работа с контентом
Оптимизация контента
Материалы
Визуальный редактор материалов
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Учебные материалы

Package Class

The Package class is a data provider for the internal FileSystem class. You can load all resources via this class. This article describes the sample located in the <UnigineSDK>/source/csharp/samples/Api/Systems/Package/ directory.

Notice
In the C# API you can inherit from the Package class only once.

See also#

  • An example can be found in the <UnigineSDK>/source/csharp/samples/Api/Systems/Package/ directory.
  • The C++ API Unigine::Package class and the Unigine::FileSystem class which have the same methods and behavior as in the C# API.

Package Class Usage Example#

C# Side#

To use the Unigine.Package class, you should create your own class and inherit it from the Unigine.Package class and override virtual methods.

Source code (C#)
using System;
using System.IO;
using File = System.IO.File;
using System.Runtime.InteropServices;
using Unigine;

class UnigineApp
{
	class MyPackage : Package
	{
		private FileStream file;

		public MyPackage()
		{
			Log.Message("MyPackage.ctor(): called\n");
		}

		~MyPackage()
		{
			Log.Message("MyPackage.dtor(): called\n");
		}

		// list of files
		public override int GetNumFiles()
		{
			Log.Message("MyPackage.GetNumFiles(): called\n");
			return 2;
		}

		public override string GetFileName(int num)
		{
			Log.Message("MyPackage.GetFileName({0}): called\n", num);
			if (num == 0)
				return "data/package.usc";
			if (num == 1)
				return "data/package.world";
			return "";
		}

		// select file
		public override bool SelectFile(string name, out int size)
		{
			Log.Message("MyPackage.SelectFile(\"{0}\",): called\n", name);

			try
			{
				file = null;
				if (name == "data/package.usc")
					file = File.OpenRead("my_data/package.usc");
				if (name == "data/package.world")
					file = File.OpenRead("my_data/package.world");
			}
			catch (Exception e)
			{
				Log.Error("MyPackage.SelectFile(): {0}\n", e.Message);
				size = 0;
				return false;
			}

			size = (int)file.Length;

			return true;
		}

		// read file
		public override bool ReadFile(IntPtr data, int size)
		{
			Log.Message("MyPackage.ReadFile(,{0}): called\n", size);

			try
			{
				byte[] src = new byte[size];
				int ret = file.Read(src, 0, size);
				Marshal.Copy(src, 0, data, ret);
			}
			catch (Exception e)
			{
				Log.Error("MyPackage.ReadFile(): {0}\n", e.Message);
				return false;
			}

			return true;
		}
	}

	/*
	 */
	[STAThread]
	static void Main(string[] args)
	{
		// add package
		MyPackage package = new MyPackage();
		FileSystem.PreloadExternPackage(package);

		// initialize engine
		Engine.Init(args);
		
		// enter main loop
		Engine.Main();

		// shutdown engine
		Engine.Shutdown();
	}
}

The MyPackage class has overridden ReadFile(), SelectFile(), GetFileName() and GetNumFiles() functions. The class operates with two files located in the my_data folder.

In the Main() function we create an instance of the MyPackage class and add it to the FileSystem before initializing the engine using the PreloadExternPackage() method.

Output#

The following result will be shown in the console:

Last update: 28.02.2023
Build: ()