Sprites - NeisesMike/VehicleFramework GitHub Wiki

A Vehicle has a variety of sprites that are used for different purposes.

Overview

ModVehicle has the fields:

public virtual Atlas.Sprite PingSprite => VehicleManager.defaultPingSprite;
public virtual Sprite UnlockedSprite => null;
public virtual Atlas.Sprite CraftingSprite => MainPatcher.ModVehicleIcon;

The PingSprite is the one that displays on the player's HUD when they are far away from the vehicle. See how to create a ping sprite.

The UnlockedSprite is the one that appears in the pop up window when the vehicle is unlocked. Here's a Nautilus tutorial for this sprite type.

The CraftingSprite is the one that appears in the Mobile Vehicle Bay.

Simple usage

If you include a png in your mod folder, you can use Vehicle Framework to easily retrieve the sprite like this:

public override Atlas.Sprite CraftingSprite => VehicleFramework.Assets.SpriteHelper.GetSprite("path/to/sprite.png");
public override Sprite UnlockedSprite => VehicleFramework.Assets.SpriteHelper.GetSpriteRaw("path/to/sprite.png");