Source.Interface.MenuUI.Managers.NgMenuContentManager Class Reference

List of all members.

Classes
struct	BngShip
	Represents a ship on the menu. More...
struct	BngTrack
	Represents a track on the menu. More...
struct	BngUgcLiverySet
struct	KeyedData
Public Types
enum	VrCockpitVisibility
enum	ShipClass
Public Member Functions
delegate void	OnUgcLoadingFailedDelegate ()
int	GetIndexOfShip (string displayName)
	Returns the index of a given ship for use with GetShipOfIndex. Positive means the ship was found in the ships array, -1 means ship not found and anything under -1 is a -2 offset in the unregistered ships array.
BngShip	GetShipOfIndex (int index)
	Returns a ship with the provided index, for use with GetIndexOfShip.
BngShip	GetFirstShipByType (EShips ship)
	Returns the first ship that shares the ship type provided.
BngShip	GetFirstCustomShipByFilePath (string filePath)
	Returns the first custom ship that shares the ship type provided.
BngShip	GetFirstShipByDisplayName (string displayName)
	Returns the first ship that shares the display name provided.
BngShip	GetFirstShipByDisplayNameCaseInsensitive (string displayName)
	Returns the first ship that shares the display name provided.
List< BngShip >	GetShipsWithDisplayNameCaseInsensitive (string displayName)
	Returns all ships with the given case inensitive diisplay name.
bool	HasShip (string displayName)
	Checks if a ship with the given display name exists in the database.
bool	HasShipIncludeEnum (string displayName)
	Checks if a ship with the given display name or enum value as display is in the database.
bool	HasTrack (string displayName)
	Checks if a track with the given display name exists in the database.
bool	HasTrackBySceneName (string sceneName)
	Checks if a track exists by its scene name.
BngTrack	GetTrackByDisplayName (string displayName)
	Returns a track by its display name.
BngTrack	GetTrackBySceneName (string sceneName)
	Returns a track by its scene name.
BngTrack	GetTrackByFilePath (string filePath)
	Returns a track by its file path (custom tracks only)/.
BngTrack	GetTrackByWorkshopId (ulong id)
	Returns a track by its workshop ID.
bool	HasWorkshopId (ulong id)
	Returns true if any workshop file loaded has the supplied ID.
bool	ShipsAlreadyContainCustomShip (string filePath)
	Returns if the ship array already has a custom ship added to it.
bool	TracksAlreadyContainsCustomTracK (string filePath)
	Returns if the track array already has a custom track added to it.
void	SetCustomShipCategory (string name, List< int > pointers)
	Sets an existing or adds a new custom ship category with the given data.
bool	IsTrackCategoryUnavailableInCurrentGameContext (int categoryIndex)
	Returns whether the category of the specified index can be displayed or selected by the user in the game's current context.
List< KeyedData >	GetAvailableTrackCategoriesInCurrentGameContext ()
	Returns the current avaiilable track categories in the game's current context.
List< NgShipTurntable.EShipSets >	GetAllShipSets ()
List< NgShipTurntable.EShipSets >	GetAvailableShipSetsInCurrentGameContext ()
	Returns the current available ship sets in the game's current context.
BngShip	RegisterUnregisteredShip (string displayName)
	Attempts to find the ship with the provided display name in the unregistered ships list and moves it into the registered list. Returns the ship. If the ship wasn't found then the returned struct will be empty.
void	AddShipToStandardRoster (BngShip ship, string afterDisplayName)
	Adds a ship to the standard ship roster list.
void	SetTrackCategory (string name, List< int > pointers)
	Sets an existing or adds a new track category with the given data.
string[]	CreateCustomTracks ()
	Loads in all of the custom tracks and automatically categorises.
void	FinalizeCustomTracks (CustomTrackCache.CustomTrackInformation[] information)
	Finalizes the configuration of custom tracks.
void	AddTracks (List< BngTrack > tracks)
	Adds a new track to the database.
void	ClearCustomLiveries ()
	Clears all custom liveries.
void	RefreshCustomLiveries ()
	Refreshes custom liveries.
Static Public Member Functions
static void	SetTrack (BngTrack track)
	Sets the track that will be loaded next.
static void	SetShip (BngShip ship, int playerIndex, int shipIndex, int customCategoryIndex, int liveryIndex, int schemeIndex)
	Sets the ship that will be used for a given player.
static void	MoveUncategorisedFiles (string rootPath, params string[] searchPatterns)
	Moves uncategorised mod files into a mod folder.
static string[]	GetFiles (string path, string format1, string format2)
Public Attributes
List< BngShip >	Ships = new List<BngShip>()
List< BngShip >	UnregisteredShips = new List<BngShip>()
List< BngTrack >	Tracks = new List<BngTrack>()
KeyedData	StandardShipCategory
KeyedData	DragShipCategory
KeyedData	DriftShipCategory
KeyedData	SurvivalShipCategory
KeyedData	SmallVehicleCategory
List< KeyedData >	CustomShipCategories = new List<KeyedData>()
List< KeyedData >	TrackCategories = new List<KeyedData>()
int	CurrentCustomCategoryIndex = -1
int	CurrentCustomShipIndex = -1
Static Public Attributes
static OnUgcLoadingFailedDelegate	OnUgcLoadingFailed
static int	CustomShipCount
static int	CustomTrackCount
Properties
static NgMenuContentManager	Instance [get]

---

Member Function Documentation

void Source.Interface.MenuUI.Managers.NgMenuContentManager.AddShipToStandardRoster	(	BngShip	ship,
		string	afterDisplayName
	)		[inline]

Adds a ship to the standard ship roster list.

Parameters:

ship	The ship to add to the roster. This will be searched for in the ship list so make sure RegisterUnregisteredShip is called first.
afterDisplayName	The ship to insert the new ship after. If the ship isn't found then it will be added to the end.

void Source.Interface.MenuUI.Managers.NgMenuContentManager.AddTracks

(

List< BngTrack >

tracks

)

[inline]

Adds a new track to the database.

void Source.Interface.MenuUI.Managers.NgMenuContentManager.ClearCustomLiveries

(

)

[inline]

Clears all custom liveries.

string [] Source.Interface.MenuUI.Managers.NgMenuContentManager.CreateCustomTracks

(

)

[inline]

Loads in all of the custom tracks and automatically categorises.

void Source.Interface.MenuUI.Managers.NgMenuContentManager.FinalizeCustomTracks

(

CustomTrackCache.CustomTrackInformation[]

information

)

[inline]

Finalizes the configuration of custom tracks.

Parameters:

information

List<NgShipTurntable.EShipSets> Source.Interface.MenuUI.Managers.NgMenuContentManager.GetAvailableShipSetsInCurrentGameContext

(

)

[inline]

Returns the current available ship sets in the game's current context.

Returns:

List<KeyedData> Source.Interface.MenuUI.Managers.NgMenuContentManager.GetAvailableTrackCategoriesInCurrentGameContext

(

)

[inline]

Returns the current avaiilable track categories in the game's current context.

Returns:

BngShip Source.Interface.MenuUI.Managers.NgMenuContentManager.GetFirstCustomShipByFilePath

(

string

filePath

)

[inline]

Returns the first custom ship that shares the ship type provided.

BngShip Source.Interface.MenuUI.Managers.NgMenuContentManager.GetFirstShipByDisplayName

(

string

displayName

)

[inline]

Returns the first ship that shares the display name provided.

BngShip Source.Interface.MenuUI.Managers.NgMenuContentManager.GetFirstShipByDisplayNameCaseInsensitive

(

string

displayName

)

[inline]

Returns the first ship that shares the display name provided.

BngShip Source.Interface.MenuUI.Managers.NgMenuContentManager.GetFirstShipByType

(

EShips

ship

)

[inline]

Returns the first ship that shares the ship type provided.

int Source.Interface.MenuUI.Managers.NgMenuContentManager.GetIndexOfShip

(

string

displayName

)

[inline]

Returns the index of a given ship for use with GetShipOfIndex. Positive means the ship was found in the ships array, -1 means ship not found and anything under -1 is a -2 offset in the unregistered ships array.

Parameters:

displayName

Returns:

BngShip Source.Interface.MenuUI.Managers.NgMenuContentManager.GetShipOfIndex

(

int

index

)

[inline]

Returns a ship with the provided index, for use with GetIndexOfShip.

List<BngShip> Source.Interface.MenuUI.Managers.NgMenuContentManager.GetShipsWithDisplayNameCaseInsensitive

(

string

displayName

)

[inline]

Returns all ships with the given case inensitive diisplay name.

BngTrack Source.Interface.MenuUI.Managers.NgMenuContentManager.GetTrackByDisplayName

(

string

displayName

)

[inline]

Returns a track by its display name.

Returns:

BngTrack Source.Interface.MenuUI.Managers.NgMenuContentManager.GetTrackByFilePath

(

string

filePath

)

[inline]

Returns a track by its file path (custom tracks only)/.

Returns:

BngTrack Source.Interface.MenuUI.Managers.NgMenuContentManager.GetTrackBySceneName

(

string

sceneName

)

[inline]

Returns a track by its scene name.

Returns:

BngTrack Source.Interface.MenuUI.Managers.NgMenuContentManager.GetTrackByWorkshopId

(

ulong

id

)

[inline]

Returns a track by its workshop ID.

Returns:

bool Source.Interface.MenuUI.Managers.NgMenuContentManager.HasShip

(

string

displayName

)

[inline]

Checks if a ship with the given display name exists in the database.

bool Source.Interface.MenuUI.Managers.NgMenuContentManager.HasShipIncludeEnum

(

string

displayName

)

[inline]

Checks if a ship with the given display name or enum value as display is in the database.

Returns:

bool Source.Interface.MenuUI.Managers.NgMenuContentManager.HasTrack

(

string

displayName

)

[inline]

Checks if a track with the given display name exists in the database.

bool Source.Interface.MenuUI.Managers.NgMenuContentManager.HasTrackBySceneName

(

string

sceneName

)

[inline]

Checks if a track exists by its scene name.

bool Source.Interface.MenuUI.Managers.NgMenuContentManager.HasWorkshopId

(

ulong

id

)

[inline]

Returns true if any workshop file loaded has the supplied ID.

bool Source.Interface.MenuUI.Managers.NgMenuContentManager.IsTrackCategoryUnavailableInCurrentGameContext

(

int

categoryIndex

)

[inline]

Returns whether the category of the specified index can be displayed or selected by the user in the game's current context.

static void Source.Interface.MenuUI.Managers.NgMenuContentManager.MoveUncategorisedFiles	(	string	rootPath,
		params string[]	searchPatterns
	)		[inline, static]

Moves uncategorised mod files into a mod folder.

void Source.Interface.MenuUI.Managers.NgMenuContentManager.RefreshCustomLiveries

(

)

[inline]

Refreshes custom liveries.

BngShip Source.Interface.MenuUI.Managers.NgMenuContentManager.RegisterUnregisteredShip

(

string

displayName

)

[inline]

Attempts to find the ship with the provided display name in the unregistered ships list and moves it into the registered list. Returns the ship. If the ship wasn't found then the returned struct will be empty.

void Source.Interface.MenuUI.Managers.NgMenuContentManager.SetCustomShipCategory	(	string	name,
		List< int >	pointers
	)		[inline]

Sets an existing or adds a new custom ship category with the given data.

static void Source.Interface.MenuUI.Managers.NgMenuContentManager.SetShip	(	BngShip	ship,
		int	playerIndex,
		int	shipIndex,
		int	customCategoryIndex,
		int	liveryIndex,
		int	schemeIndex
	)		[inline, static]

Sets the ship that will be used for a given player.

static void Source.Interface.MenuUI.Managers.NgMenuContentManager.SetTrack

(

BngTrack

track

)

[inline, static]

Sets the track that will be loaded next.

void Source.Interface.MenuUI.Managers.NgMenuContentManager.SetTrackCategory	(	string	name,
		List< int >	pointers
	)		[inline]

Sets an existing or adds a new track category with the given data.

bool Source.Interface.MenuUI.Managers.NgMenuContentManager.ShipsAlreadyContainCustomShip

(

string

filePath

)

[inline]

Returns if the ship array already has a custom ship added to it.

bool Source.Interface.MenuUI.Managers.NgMenuContentManager.TracksAlreadyContainsCustomTracK

(

string

filePath

)

[inline]

Returns if the track array already has a custom track added to it.

---

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

• A:/Projects/Unity/BallisticNG/Assets/Source/Interface/MenuUI/Managers/NgMenuContentManager.cs