BallisticNG: Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip Struct Reference

Represents a ship on the menu. More...

Public Member Functions
string	GetLiveryName (int index)
	Returns the name of the livery with the given index.
ShipLivery	GetLiveryByName (string name, out int index)
	Returns a livery by its name.
Public Attributes
string	DisplayName
	The name to display on the menu.
string	DisplayDescription
	the description to display on the menu.
List< ShipLivery >	ShipLiveries
	The liveries textures to load into the interface.
bool	IsCustomShip
	If true then this ship is a custom ship.
bool	CsfFormat
	If true then this ship is a custom ship using the new csf format.
bool	IsLocked = > UserProgress.CurrentRank < UnlockRank && !NgNetworkBase.CurrentNetwork \|\| NgCampaign.NgCampaign.Enabled && LockedInCampaign && !NgCampaign.NgCampaign.CurrentList.BarracudaAllowed \|\| Ship == EShips.PrecisionShip && !PrecisionSave.PrecisionShipUnlocked && !NgNetworkBase.CurrentNetwork && !Cheats.MaxRank \|\| NgNetworkBase.CurrentNetwork && !MultiplayerAllowed
	If true then this ship is locked.
bool	IsLockedInCampaign = > NgCampaign.NgCampaign.Enabled && LockedInCampaign && !NgCampaign.NgCampaign.CurrentList.BarracudaAllowed
	If true then this ship is currently locked but only inside of the current campaign.
int	UnlockRank
	The rank needed to unlock this ship.
string	UnlockText
	The text to display when this ship is locked.
bool	LockedInCampaign
	if true then this ship will be unavailable in the campaign.
string	FilePath
	If this is a custom ship then this points to the ship file.
EShips	Ship
	THe enumeration value of this ship, used to load the ship prefabs for data.
VrCockpitVisibility	CockpitVisibility
	The cockpit visibility for this ship, used for VR.
ShipClass	Class
	The class that this ship belongs in.
Vector3	Offset
	How much to offset the ship mesh by.
Vector3	Rotation
	How much to rotate the ship mesh by.
Vector3	Scale
	How much to the scale the ship by.
bool	IsWorkshop
	If true then this is a workshop ship.
ulong	WorkshopID
	The workshop ID of this ship if it's a workshop ship.
int	AccelerationStat
int	SpeedStat
int	HandlingStat
int	ShieldStat
int	FirepowerStat
bool	AiIgnoreLiveryIndex
Properties
bool	MultiplayerAllowed `[get]`
	If true then this ship is available in multiplayer.

Detailed Description

Represents a ship on the menu.

Member Function Documentation

ShipLivery Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.GetLiveryByName	(	string	name,
		out int	index
	)		`[inline]`

Returns a livery by its name.

string Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.GetLiveryName ( int index ) [inline]

Returns the name of the livery with the given index.

Parameters:

index

Member Data Documentation

ShipClass Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.Class

The class that this ship belongs in.

VrCockpitVisibility Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.CockpitVisibility

The cockpit visibility for this ship, used for VR.

bool Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.CsfFormat

If true then this ship is a custom ship using the new csf format.

string Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.DisplayDescription

the description to display on the menu.

string Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.DisplayName

The name to display on the menu.

string Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.FilePath

If this is a custom ship then this points to the ship file.

bool Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.IsCustomShip

If true then this ship is a custom ship.

bool Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.IsLocked = > UserProgress.CurrentRank < UnlockRank && !NgNetworkBase.CurrentNetwork || NgCampaign.NgCampaign.Enabled && LockedInCampaign && !NgCampaign.NgCampaign.CurrentList.BarracudaAllowed || Ship == EShips.PrecisionShip && !PrecisionSave.PrecisionShipUnlocked && !NgNetworkBase.CurrentNetwork && !Cheats.MaxRank || NgNetworkBase.CurrentNetwork && !MultiplayerAllowed

If true then this ship is locked.

bool Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.IsLockedInCampaign = > NgCampaign.NgCampaign.Enabled && LockedInCampaign && !NgCampaign.NgCampaign.CurrentList.BarracudaAllowed

If true then this ship is currently locked but only inside of the current campaign.

bool Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.IsWorkshop

If true then this is a workshop ship.

bool Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.LockedInCampaign

if true then this ship will be unavailable in the campaign.

Vector3 Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.Offset

How much to offset the ship mesh by.

Vector3 Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.Rotation

How much to rotate the ship mesh by.

Vector3 Source.Interface.MenuUI.Managers.NgMenuContentManager.BngShip.Scale