Barotrauma Server
Loading...
Searching...
No Matches
Barotrauma.ContentFile Class Referenceabstract

Base class for content file types, which are loaded from filelist.xml via reflection. PLEASE AVOID INHERITING FROM THIS CLASS DIRECTLY. Inheriting from GenericPrefabFile<T> is likely what you want. More...

Inheritance diagram for Barotrauma.ContentFile:
Barotrauma.AfflictionsFile Barotrauma.BaseSubFile Barotrauma.CharacterFile Barotrauma.DecalsFile Barotrauma.GenericPrefabFile< T > Barotrauma.HashlessFile Barotrauma.JobsFile Barotrauma.LevelGenerationParametersFile Barotrauma.MapGenerationParametersFile Barotrauma.NPCConversationsFile Barotrauma.OrdersFile Barotrauma.RandomEventsFile Barotrauma.SkillSettingsFile Barotrauma.TextFile

Classes

class  TypeInfo
 

Public Member Functions

void LoadFile ()
 
void UnloadFile ()
 
void Sort ()
 
virtual void Preload (Action< Sprite > addPreloadedSprite)
 
virtual Md5Hash CalculateHash ()
 

Static Public Member Functions

static bool IsLegacyContentType (XElement contentFileElement, ContentPackage package, bool logWarning)
 
static Result< ContentFile, ContentPackage.LoadErrorCreateFromXElement (ContentPackage contentPackage, XElement element)
 

Public Attributes

readonly ContentPackage ContentPackage
 
readonly ContentPath Path
 
readonly Md5Hash Hash
 

Static Public Attributes

static readonly ImmutableHashSet< TypeInfoTypes
 

Protected Member Functions

 ContentFile (ContentPackage contentPackage, ContentPath path)
 

Properties

bool NotSyncedInMultiplayer [get]
 

Detailed Description

Base class for content file types, which are loaded from filelist.xml via reflection. PLEASE AVOID INHERITING FROM THIS CLASS DIRECTLY. Inheriting from GenericPrefabFile<T> is likely what you want.

Constructor & Destructor Documentation

◆ ContentFile()

Barotrauma.ContentFile.ContentFile ( ContentPackage contentPackage,
ContentPath path )
protected

Member Function Documentation

◆ CalculateHash()

virtual Md5Hash Barotrauma.ContentFile.CalculateHash ( )
virtual

◆ CreateFromXElement()

static Result< ContentFile, ContentPackage.LoadError > Barotrauma.ContentFile.CreateFromXElement ( ContentPackage contentPackage,
XElement element )
static

◆ IsLegacyContentType()

static bool Barotrauma.ContentFile.IsLegacyContentType ( XElement contentFileElement,
ContentPackage package,
bool logWarning )
static

◆ LoadFile()

void Barotrauma.ContentFile.LoadFile ( )
abstract

◆ Preload()

virtual void Barotrauma.ContentFile.Preload ( Action< Sprite > addPreloadedSprite)
virtual

Reimplemented in Barotrauma.CharacterFile.

◆ Sort()

void Barotrauma.ContentFile.Sort ( )
abstract

◆ UnloadFile()

void Barotrauma.ContentFile.UnloadFile ( )
abstract

Member Data Documentation

◆ ContentPackage

readonly ContentPackage Barotrauma.ContentFile.ContentPackage

◆ Hash

readonly Md5Hash Barotrauma.ContentFile.Hash

◆ Path

readonly ContentPath Barotrauma.ContentFile.Path

◆ Types

readonly ImmutableHashSet<TypeInfo> Barotrauma.ContentFile.Types
static

Property Documentation

◆ NotSyncedInMultiplayer

bool Barotrauma.ContentFile.NotSyncedInMultiplayer
get

The documentation for this class was generated from the following file: