diff --git a/api/Nautilus.Assets.PrefabInfo.html b/api/Nautilus.Assets.PrefabInfo.html index 1a1a714f3..ee50179e0 100644 --- a/api/Nautilus.Assets.PrefabInfo.html +++ b/api/Nautilus.Assets.PrefabInfo.html @@ -506,7 +506,7 @@

Parameters

language string
The language for this entry. Defaults to English.
unlockAtStart bool
-
Whether this tech type should be unlocked on game start or not. Default to true.
+
Whether this tech type should be unlocked on game start or not. Defaults to false.
techTypeOwner Assembly
The assembly that owns the created tech type. The name of this assembly will be shown in the PDA.
diff --git a/api/Nautilus.Handlers.PrefabCollection.html b/api/Nautilus.Handlers.PrefabCollection.html index 892299ebd..f0b2ba68b 100644 --- a/api/Nautilus.Handlers.PrefabCollection.html +++ b/api/Nautilus.Handlers.PrefabCollection.html @@ -89,7 +89,7 @@
Table of Contents

-Class PrefabCollection +Class PrefabCollection

@@ -200,7 +200,7 @@

Methods

Add(PrefabInfo, PrefabFactoryAsync, PrefabPostProcessorAsync) - +

Adds a prefab info with the function that constructs the game object into the game.
@@ -235,7 +235,7 @@

Parameters

ContainsPrefabInfo(PrefabInfo) - +

Determines whether the provided prefab info is registered.
@@ -271,7 +271,7 @@

Returns

Remove(PrefabInfo) - +

Removes a prefab info from the game. This leads to unregistering the specified prefab info from the game.
@@ -308,7 +308,7 @@

Returns

TryGetInfoForClassId(string, out PrefabInfo) - +

Gets the prefab info associated with the provided class ID.
@@ -346,7 +346,7 @@

Returns

TryGetInfoForFileName(string, out PrefabInfo) - +

Gets the prefab info associated with the provided file name.
@@ -384,7 +384,7 @@

Returns

TryGetInfoForTechType(TechType, out PrefabInfo) - +

Gets the prefab info associated with the provided tech type.
@@ -422,7 +422,7 @@

Returns

TryGetPostProcessorForInfo(PrefabInfo, out PrefabPostProcessorAsync) - +

Gets the prefab post processor associated with the provided info.
@@ -460,7 +460,7 @@

Returns

TryGetPrefabForInfo(PrefabInfo, out PrefabFactoryAsync) - +

Gets the prefab factory associated with the provided info.
@@ -498,7 +498,7 @@

Returns

- Edit this page + Edit this page
diff --git a/api/Nautilus.Handlers.PrefabCollectionExtensions.html b/api/Nautilus.Handlers.PrefabCollectionExtensions.html index 8f9eab08b..652785604 100644 --- a/api/Nautilus.Handlers.PrefabCollectionExtensions.html +++ b/api/Nautilus.Handlers.PrefabCollectionExtensions.html @@ -89,7 +89,7 @@
Table of Contents

-Class PrefabCollectionExtensions +Class PrefabCollectionExtensions

@@ -156,7 +156,7 @@

Methods

RegisterPrefab(PrefabCollection, ICustomPrefab) - +

Registers a CustomPrefab into the game.
@@ -189,7 +189,7 @@

Parameters

UnregisterPrefab(PrefabCollection, ICustomPrefab) - +

Unregisters a CustomPrefab from the game.
@@ -222,7 +222,7 @@

Parameters

diff --git a/api/Nautilus.Handlers.SpawnInfo.html b/api/Nautilus.Handlers.SpawnInfo.html index 08c86e718..bba4dd1b7 100644 --- a/api/Nautilus.Handlers.SpawnInfo.html +++ b/api/Nautilus.Handlers.SpawnInfo.html @@ -146,7 +146,7 @@

Constructors

SpawnInfo(string, Vector3) - +

Initializes a new SpawnInfo.
@@ -179,7 +179,7 @@

Parameters

SpawnInfo(string, Vector3, Quaternion) - +

Initializes a new SpawnInfo.
@@ -214,7 +214,7 @@

Parameters

SpawnInfo(string, Vector3, Quaternion, Vector3) - +

Initializes a new SpawnInfo.
@@ -247,11 +247,50 @@

Parameters

+ + +

+ SpawnInfo(string, Vector3, Quaternion, Vector3, Action<GameObject>) + +

+ +
Initializes a new SpawnInfo.
+
+ +
+
public SpawnInfo(string classId, Vector3 spawnPosition, Quaternion rotation, Vector3 scale, Action<GameObject> onSpawned)
+
+ +

Parameters

+
+
classId string
+
ClassID to spawn.
+
spawnPosition Vector3
+
Position to spawn into.
+
rotation Quaternion
+
Rotation to spawn at.
+
scale Vector3
+
Scale to spawn with.
+
onSpawned Action<GameObject>
+
Callback that is used when the object is successfully spawned.
+
+ + + + + + + + + + + +

SpawnInfo(string, Vector3, Vector3) - +

Initializes a new SpawnInfo.
@@ -286,7 +325,7 @@

Parameters

SpawnInfo(string, Vector3, Vector3, Vector3) - +

Initializes a new SpawnInfo.
@@ -323,7 +362,7 @@

Parameters

SpawnInfo(TechType, Vector3) - +

Initializes a new SpawnInfo.
@@ -356,7 +395,7 @@

Parameters

SpawnInfo(TechType, Vector3, Quaternion) - +

Initializes a new SpawnInfo.
@@ -391,7 +430,7 @@

Parameters

SpawnInfo(TechType, Vector3, Quaternion, Vector3) - +

Initializes a new SpawnInfo.
@@ -424,11 +463,50 @@

Parameters

+ + +

+ SpawnInfo(TechType, Vector3, Quaternion, Vector3, Action<GameObject>) + +

+ +
Initializes a new SpawnInfo.
+
+ +
+
public SpawnInfo(TechType techType, Vector3 spawnPosition, Quaternion rotation, Vector3 scale, Action<GameObject> onSpawned)
+
+ +

Parameters

+
+
techType TechType
+
TechType to spawn.
+
spawnPosition Vector3
+
Position to spawn into.
+
rotation Quaternion
+
Rotation to spawn at.
+
scale Vector3
+
Scale to spawn with.
+
onSpawned Action<GameObject>
+
Callback that is used when the object is successfully spawned.
+
+ + + + + + + + + + + +

SpawnInfo(TechType, Vector3, Vector3) - +

Initializes a new SpawnInfo.
@@ -463,7 +541,7 @@

Parameters

SpawnInfo(TechType, Vector3, Vector3, Vector3) - +

Initializes a new SpawnInfo.
@@ -504,7 +582,7 @@

Methods

Equals(SpawnInfo) - +

Indicates whether the current SpawnInfo is equal to another.
@@ -545,7 +623,7 @@

Equals(object) - +

Indicates whether this instance and a specified object are equal.
@@ -592,7 +670,7 @@

GetHashCode() - +

A custom hash code algorithm that takes into account the values of each property of the SpawnInfo instance, @@ -628,7 +706,7 @@

Operators

operator ==(SpawnInfo, SpawnInfo) - +

Indicates whether two SpawnInfo instances are equal.
@@ -673,7 +751,7 @@

Returns

operator !=(SpawnInfo, SpawnInfo) - +

Indicates whether two SpawnInfo instances are not equal.
diff --git a/guides/sml2-to-nautilus.html b/guides/sml2-to-nautilus.html index f5497d2d2..0b9488214 100644 --- a/guides/sml2-to-nautilus.html +++ b/guides/sml2-to-nautilus.html @@ -90,9 +90,11 @@

Updating to Nautilus

In this article, we will be talking about the necessary changes you must apply to update your mod to Nautilus from SMLHelper 2.0.

Namespace

The root namespace for Nautilus is not the same as SMLHelper 2.0.

-
+
+
 - <RootNamespace>SMLHelper.V2</RootNamespace>
 + <RootNamespace>Nautilus</RootNamespace>
+
 

Referencing

In BepInEx, we no longer use a mod.json file to determine dependencies. Instead, this is done via the [BepInDependency] attribute. @@ -104,7 +106,8 @@

Handlers

mentioned in your code.

Handler.cs

Following the handler interfaces change, the overly under-used Handler class will leave us in Nautilus

-
+
+
 // Handler.cs
 
 - namespace SMLHelper.V2
@@ -126,21 +129,25 @@ 

Handler.cs

- ... - }
+

BioReactorHandler

The BioReactorHandler class is removed in Nautilus because it only had one very simple method to patch, and was forcing patch-time. That means if you tried to modify a bio charge after SML's entry point, it didn't get applied.

The following example demonstrates how you can implement the same functionality the BioReactorHandler class offered.

-
+
+
 - BioReactorHandler.SetBioreactorCharge(TechType.Peeper, 69f);
 + BaseBioReactor.charge[TechType.Peeper] = 69f;
+
 

FishHandler

Ever since this class has been added, it never received any further updates due to unpopularity among modders, and unfamiliarity with how creatures worked in general and thus, has been broken for a long time.
The FishHandler has been removed in Nautilus. At the time being, we have not added a system to replace it, so stay tuned for that.

PDAEncyclopediaHandler And PDALogHandler

Beginning with Nautilus, both of these handler methods were moved to PDAHandler as they only had one method each.

-
+
+
 PDAEncyclopedia.EntryData entry = new PDAEncyclopedia.EntryData()
 {
   key = "SomeEncy",
@@ -153,12 +160,15 @@ 

PDAEncyclopediaHandler And PDA - PDALogHandler.AddCustomEntry("SomeLog", "SomeLanguageKey"); + PDAHandler.AddLogEntry("SomeLog", "SomeLanguageKey"); +

InGameMenuHandler

The methods InGameMenuHandler class had have been moved to the Nautilus.Utility namespace and the class has been renamed to SaveUtils.

-
+
+
 - InGameMenuHandler.RegisterOnSaveEvent(() => ErrorMessage.AddMessage("We do be saving!"));
 + SaveUtils.RegisterOnSaveEvent(() => ErrorMessage.AddMessage("We do be saving!"));
+
 

Enum Handlers

Beginning with Nautilus, enum handling will be made generic. Instead of working with individual handlers associated with the enum type (E.G: For TechType we had TechTypeHandler), @@ -207,31 +217,40 @@

Note

Below we will talk about the necessary changes you will need to make your custom enum values work for each of the aforementioned handlers.

Configuring Custom TechType Objects

-
+
+
 - TechType customTech = TechTypeHandler.AddTechType("CustomTech", "Custom Tech", "Custom Tech that makes me go yes.", SpriteManager.Get(TechType.Titanium), unlockedAtStart: false);
 + TechType customTech = EnumHandler.AddEntry<TechType>("CustomTech")
 +             .WithPdaInfo("Custom Tech", "Custom Tech that makes me go yes.", unlockedAtStart: false)
 +             .WithIcon(SpriteManager.Get(TechType.Titanium));
+
 

Configuring Custom CraftData.BackgroundType Objects

-
+
+
 - CraftData.BackgroundType customBG = BackgroundTypeHandler.AddBackgroundType("CustomBackground", SpriteManager.GetBackground(TechType.Battery));
 + CraftData.BackgroundType customBG = EnumHandler.AddEntry<CraftData.BackgroundType>("CustomBackground")
 +             .WithBackground(SpriteManager.GetBackground(TechType.Battery));
+
 

Configuring Custom EquipmentType Objects

-
+
+
 - EquipmentType customEquipment = EquipmentHandler.AddEquipmentType("CustomEquipment");
 + EquipmentType customEquipment = EnumHandler.AddEntry<EquipmentType>("CustomEquipment");
+
 

Configuring Custom PingType Objects

-
+
+
 - PingType customPing = PingHandler.RegisterNewPingType("CustomPing", SpriteManager.Get(SpriteManager.Group.Pings, PingType.Signal.ToString()));
 + PingType customPing = EnumHandler.AddEntry<PingType>("CustomPing")
 +             .WithIcon(SpriteManager.Get(SpriteManager.Group.Pings, PingType.Signal.ToString()));
+
 

Configuring Custom TechCategory and TechGroup Objects

-
+
+
 - TechGroup customGroup = TechGroupHandler.AddTechCategory("CustomGroup", "Custom Group");
 + TechGroup customGroup = EnumHandler.AddEntry<TechCategory>("CustomGroup").WithPdaInfo("Custom Group");
 
@@ -239,14 +258,17 @@ 

Configuring Custo - TechCategoryHandler.TryRegisterTechCategoryToTechGroup(customGroup, customCategory); + TechCategory customCategory = EnumHandler.AddEntry<TechCategory>("CustomCategory").WithPdaInfo("Custom Group") + .RegisterToTechGroup(customGroup); +

Configuring Custom CraftTree.Type Objects

-
+
+
 - ModCraftTreeRoot root = CraftTreeHandler.CreateCustomCraftTreeAndType(CustomTree, out CraftTree.Type customTree);
 + CraftTree.Type customTree = EnumHandler.AddEntry<CraftTree.Type>("CustomTree")
 +             .CreateCraftTreeRoot(out ModCraftTreeRoot root);
 
 root.AddTabNode("SomeTab");
+
 

Options

@@ -603,7 +625,8 @@

Audio and FMOD

CustomSoundHandler and AudioUtils classes, as well as the SoundChannel enumeration in Nautilus.

Beginning with Nautilus, all custom sounds will require a bus instead of a SoundChannel to determine the effects (E.G: reverb, muffling, low-pass, etc..) and the volume slider.
Additionally, the PlaySound signature was also modified and renamed to TryPlaySound.

-
+
+
 - Channel channel = AudioUtils.PlaySound(soundPath, SoundChannel.Music);
 + if (AudioUtils.TryPlaySound(soundPath, AudioUtils.BusPaths.Music, out Channel channel))
 + {
@@ -631,6 +654,7 @@ 

Audio and FMOD

+ // do something with channel + }
+
Warning
diff --git a/index.json b/index.json index 7fc3204cc..f67998735 100644 --- a/index.json +++ b/index.json @@ -92,7 +92,7 @@ "api/Nautilus.Assets.PrefabInfo.html": { "href": "api/Nautilus.Assets.PrefabInfo.html", "title": "Struct PrefabInfo", - "keywords": "Struct PrefabInfo Namespace Nautilus.Assets Assembly Nautilus.dll Data class that represents information about a prefab. public record struct PrefabInfo : IEquatable Implements IEquatable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() object.Equals(object, object) object.ReferenceEquals(object, object) object.GetType() Constructors PrefabInfo(string, string, TechType) Data class that represents information about a prefab. public PrefabInfo(string ClassID, string PrefabFileName, TechType TechType) Parameters ClassID string The class identifier used for the PrefabIdentifier component whenever applicable. PrefabFileName string Name of the prefab file. TechType TechType The TechType of the corresponding item. Properties ClassID The class identifier used for the PrefabIdentifier component whenever applicable. public string ClassID { readonly get; set; } Property Value string PrefabFileName Name of the prefab file. public string PrefabFileName { readonly get; set; } Property Value string TechType The TechType of the corresponding item. public TechType TechType { readonly get; set; } Property Value TechType Methods WithFileName(string) Sets the prefab file name as prefab info. public PrefabInfo WithFileName(string fileName) Parameters fileName string The prefab file name. Returns PrefabInfo A reference to this instance after the operation has completed. WithIcon(Sprite) Adds an icon for TechType. public PrefabInfo WithIcon(Atlas.Sprite sprite) Parameters sprite Atlas.Sprite Returns PrefabInfo A reference to this instance after the operation has completed. WithIcon(Sprite) Adds an icon for TechType. public PrefabInfo WithIcon(Sprite sprite) Parameters sprite Sprite Returns PrefabInfo A reference to this instance after the operation has completed. WithSizeInInventory(Vector2int) Sets the size of this tech type in the inventory. public PrefabInfo WithSizeInInventory(Vector2int size) Parameters size Vector2int The 2x2 vector size Returns PrefabInfo A reference to this instance after the operation has completed. WithTechType(string, bool, Assembly) Constructs a new PrefabInfo instance with automatically set PrefabFileName and TechType. public static PrefabInfo WithTechType(string classId, bool unlockAtStart = false, Assembly techTypeOwner = null) Parameters classId string The class identifier used for the PrefabIdentifier component whenever applicable. unlockAtStart bool Whether this tech type should be unlocked on game start or not. Default to true. techTypeOwner Assembly The assembly that owns the created tech type. The name of this assembly will be shown in the PDA. Returns PrefabInfo An instance of the constructed PrefabInfo. Remarks This overload does not do anything about the language side of this prefab (DisplayName and Description) and assumes that the entries were already added. For the DisplayName, the language line must be \"{ClassID}\". For the Description, the language line must be \"Tooltip_{ClassID}\" instead. See Also WithTechType(string, string, string, string, bool, Assembly) SetLanguageLine(string, string, string) RegisterLocalizationFolder(string) RegisterLocalization(string, Dictionary) WithTechType(string, string, string, string, bool, Assembly) Constructs a new PrefabInfo instance with automatically set PrefabFileName and TechType. public static PrefabInfo WithTechType(string classId, string displayName, string description, string language = \"English\", bool unlockAtStart = false, Assembly techTypeOwner = null) Parameters classId string The class identifier used for the PrefabIdentifier component whenever applicable. displayName string The display name of this Tech Type, can be anything. If null or empty, this will use the language line \"{enumName}\" instead. description string The tooltip displayed when hovered in the PDA, can be anything. If null or empty, this will use the language line \"Tooltip_{enumName}\" instead. language string The language for this entry. Defaults to English. unlockAtStart bool Whether this tech type should be unlocked on game start or not. Default to true. techTypeOwner Assembly The assembly that owns the created tech type. The name of this assembly will be shown in the PDA. Returns PrefabInfo An instance of the constructed PrefabInfo." + "keywords": "Struct PrefabInfo Namespace Nautilus.Assets Assembly Nautilus.dll Data class that represents information about a prefab. public record struct PrefabInfo : IEquatable Implements IEquatable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() object.Equals(object, object) object.ReferenceEquals(object, object) object.GetType() Constructors PrefabInfo(string, string, TechType) Data class that represents information about a prefab. public PrefabInfo(string ClassID, string PrefabFileName, TechType TechType) Parameters ClassID string The class identifier used for the PrefabIdentifier component whenever applicable. PrefabFileName string Name of the prefab file. TechType TechType The TechType of the corresponding item. Properties ClassID The class identifier used for the PrefabIdentifier component whenever applicable. public string ClassID { readonly get; set; } Property Value string PrefabFileName Name of the prefab file. public string PrefabFileName { readonly get; set; } Property Value string TechType The TechType of the corresponding item. public TechType TechType { readonly get; set; } Property Value TechType Methods WithFileName(string) Sets the prefab file name as prefab info. public PrefabInfo WithFileName(string fileName) Parameters fileName string The prefab file name. Returns PrefabInfo A reference to this instance after the operation has completed. WithIcon(Sprite) Adds an icon for TechType. public PrefabInfo WithIcon(Atlas.Sprite sprite) Parameters sprite Atlas.Sprite Returns PrefabInfo A reference to this instance after the operation has completed. WithIcon(Sprite) Adds an icon for TechType. public PrefabInfo WithIcon(Sprite sprite) Parameters sprite Sprite Returns PrefabInfo A reference to this instance after the operation has completed. WithSizeInInventory(Vector2int) Sets the size of this tech type in the inventory. public PrefabInfo WithSizeInInventory(Vector2int size) Parameters size Vector2int The 2x2 vector size Returns PrefabInfo A reference to this instance after the operation has completed. WithTechType(string, bool, Assembly) Constructs a new PrefabInfo instance with automatically set PrefabFileName and TechType. public static PrefabInfo WithTechType(string classId, bool unlockAtStart = false, Assembly techTypeOwner = null) Parameters classId string The class identifier used for the PrefabIdentifier component whenever applicable. unlockAtStart bool Whether this tech type should be unlocked on game start or not. Default to true. techTypeOwner Assembly The assembly that owns the created tech type. The name of this assembly will be shown in the PDA. Returns PrefabInfo An instance of the constructed PrefabInfo. Remarks This overload does not do anything about the language side of this prefab (DisplayName and Description) and assumes that the entries were already added. For the DisplayName, the language line must be \"{ClassID}\". For the Description, the language line must be \"Tooltip_{ClassID}\" instead. See Also WithTechType(string, string, string, string, bool, Assembly) SetLanguageLine(string, string, string) RegisterLocalizationFolder(string) RegisterLocalization(string, Dictionary) WithTechType(string, string, string, string, bool, Assembly) Constructs a new PrefabInfo instance with automatically set PrefabFileName and TechType. public static PrefabInfo WithTechType(string classId, string displayName, string description, string language = \"English\", bool unlockAtStart = false, Assembly techTypeOwner = null) Parameters classId string The class identifier used for the PrefabIdentifier component whenever applicable. displayName string The display name of this Tech Type, can be anything. If null or empty, this will use the language line \"{enumName}\" instead. description string The tooltip displayed when hovered in the PDA, can be anything. If null or empty, this will use the language line \"Tooltip_{enumName}\" instead. language string The language for this entry. Defaults to English. unlockAtStart bool Whether this tech type should be unlocked on game start or not. Defaults to false. techTypeOwner Assembly The assembly that owns the created tech type. The name of this assembly will be shown in the PDA. Returns PrefabInfo An instance of the constructed PrefabInfo." }, "api/Nautilus.Assets.PrefabPostProcessorAsync.html": { "href": "api/Nautilus.Assets.PrefabPostProcessorAsync.html", @@ -367,7 +367,7 @@ "api/Nautilus.Handlers.SpawnInfo.html": { "href": "api/Nautilus.Handlers.SpawnInfo.html", "title": "Struct SpawnInfo", - "keywords": "Struct SpawnInfo Namespace Nautilus.Handlers Assembly Nautilus.dll A basic struct that provides enough info for the CoordinatedSpawnsHandler System to function. public struct SpawnInfo : IEquatable Implements IEquatable Inherited Members ValueType.ToString() object.Equals(object, object) object.ReferenceEquals(object, object) object.GetType() Constructors SpawnInfo(string, Vector3) Initializes a new SpawnInfo. public SpawnInfo(string classId, Vector3 spawnPosition) Parameters classId string ClassID to spawn. spawnPosition Vector3 Position to spawn into. SpawnInfo(string, Vector3, Quaternion) Initializes a new SpawnInfo. public SpawnInfo(string classId, Vector3 spawnPosition, Quaternion rotation) Parameters classId string ClassID to spawn. spawnPosition Vector3 Position to spawn into. rotation Quaternion Rotation to spawn at. SpawnInfo(string, Vector3, Quaternion, Vector3) Initializes a new SpawnInfo. public SpawnInfo(string classId, Vector3 spawnPosition, Quaternion rotation, Vector3 scale) Parameters classId string ClassID to spawn. spawnPosition Vector3 Position to spawn into. rotation Quaternion Rotation to spawn at. scale Vector3 Scale to spawn with. SpawnInfo(string, Vector3, Vector3) Initializes a new SpawnInfo. public SpawnInfo(string classId, Vector3 spawnPosition, Vector3 rotation) Parameters classId string ClassID to spawn. spawnPosition Vector3 Position to spawn into. rotation Vector3 Rotation to spawn at. SpawnInfo(string, Vector3, Vector3, Vector3) Initializes a new SpawnInfo. public SpawnInfo(string classId, Vector3 spawnPosition, Vector3 rotation, Vector3 scale) Parameters classId string ClassID to spawn. spawnPosition Vector3 Position to spawn into. rotation Vector3 Rotation to spawn at. scale Vector3 Scale to spawn with. SpawnInfo(TechType, Vector3) Initializes a new SpawnInfo. public SpawnInfo(TechType techType, Vector3 spawnPosition) Parameters techType TechType TechType to spawn. spawnPosition Vector3 Position to spawn into. SpawnInfo(TechType, Vector3, Quaternion) Initializes a new SpawnInfo. public SpawnInfo(TechType techType, Vector3 spawnPosition, Quaternion rotation) Parameters techType TechType TechType to spawn. spawnPosition Vector3 Position to spawn into. rotation Quaternion Rotation to spawn at. SpawnInfo(TechType, Vector3, Quaternion, Vector3) Initializes a new SpawnInfo. public SpawnInfo(TechType techType, Vector3 spawnPosition, Quaternion rotation, Vector3 scale) Parameters techType TechType TechType to spawn. spawnPosition Vector3 Position to spawn into. rotation Quaternion Rotation to spawn at. scale Vector3 Scale to spawn with. SpawnInfo(TechType, Vector3, Vector3) Initializes a new SpawnInfo. public SpawnInfo(TechType techType, Vector3 spawnPosition, Vector3 rotation) Parameters techType TechType TechType to spawn. spawnPosition Vector3 Position to spawn into. rotation Vector3 Rotation to spawn at. SpawnInfo(TechType, Vector3, Vector3, Vector3) Initializes a new SpawnInfo. public SpawnInfo(TechType techType, Vector3 spawnPosition, Vector3 rotation, Vector3 scale) Parameters techType TechType TechType to spawn. spawnPosition Vector3 Position to spawn into. rotation Vector3 Rotation to spawn at. scale Vector3 Scale to spawn with. Methods Equals(SpawnInfo) Indicates whether the current SpawnInfo is equal to another. public bool Equals(SpawnInfo other) Parameters other SpawnInfo The other SpawnInfo. Returns bool true if the current SpawnInfo is equal to the other parameter; otherwise false. Remarks It is worth noting that we use Unity's UnityEngine.Vector3.operator ==(UnityEngine.Vector3, UnityEngine.Vector3) and UnityEngine.Quaternion.operator ==(UnityEngine.Quaternion, UnityEngine.Quaternion) operator comparisons for comparing the SpawnPosition and Rotation properties of each instance, to allow for an approximate comparison of these values. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj is a SpawnInfo and represents the same value as this instance; otherwise, false. Remarks It is worth noting that we use Unity's UnityEngine.Vector3.operator ==(UnityEngine.Vector3, UnityEngine.Vector3) and UnityEngine.Quaternion.operator ==(UnityEngine.Quaternion, UnityEngine.Quaternion) operator comparisons for comparing the SpawnPosition and Rotation properties of each instance, to allow for an approximate comparison of these values. See Also Equals(SpawnInfo) GetHashCode() A custom hash code algorithm that takes into account the values of each property of the SpawnInfo instance, and attempts to reduce diagonal collisions. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(SpawnInfo, SpawnInfo) Indicates whether two SpawnInfo instances are equal. public static bool operator ==(SpawnInfo a, SpawnInfo b) Parameters a SpawnInfo The first instance to compare. b SpawnInfo The second instance to compare. Returns bool true if the SpawnInfo instances are equal; otherwise, false. See Also operator !=(SpawnInfo, SpawnInfo) Equals(SpawnInfo) operator !=(SpawnInfo, SpawnInfo) Indicates whether two SpawnInfo instances are not equal. public static bool operator !=(SpawnInfo a, SpawnInfo b) Parameters a SpawnInfo The first instance to compare. b SpawnInfo The second instance to compare. Returns bool true if the SpawnInfo instances are not equal; otherwise, false. See Also operator ==(SpawnInfo, SpawnInfo) Equals(SpawnInfo)" + "keywords": "Struct SpawnInfo Namespace Nautilus.Handlers Assembly Nautilus.dll A basic struct that provides enough info for the CoordinatedSpawnsHandler System to function. public struct SpawnInfo : IEquatable Implements IEquatable Inherited Members ValueType.ToString() object.Equals(object, object) object.ReferenceEquals(object, object) object.GetType() Constructors SpawnInfo(string, Vector3) Initializes a new SpawnInfo. public SpawnInfo(string classId, Vector3 spawnPosition) Parameters classId string ClassID to spawn. spawnPosition Vector3 Position to spawn into. SpawnInfo(string, Vector3, Quaternion) Initializes a new SpawnInfo. public SpawnInfo(string classId, Vector3 spawnPosition, Quaternion rotation) Parameters classId string ClassID to spawn. spawnPosition Vector3 Position to spawn into. rotation Quaternion Rotation to spawn at. SpawnInfo(string, Vector3, Quaternion, Vector3) Initializes a new SpawnInfo. public SpawnInfo(string classId, Vector3 spawnPosition, Quaternion rotation, Vector3 scale) Parameters classId string ClassID to spawn. spawnPosition Vector3 Position to spawn into. rotation Quaternion Rotation to spawn at. scale Vector3 Scale to spawn with. SpawnInfo(string, Vector3, Quaternion, Vector3, Action) Initializes a new SpawnInfo. public SpawnInfo(string classId, Vector3 spawnPosition, Quaternion rotation, Vector3 scale, Action onSpawned) Parameters classId string ClassID to spawn. spawnPosition Vector3 Position to spawn into. rotation Quaternion Rotation to spawn at. scale Vector3 Scale to spawn with. onSpawned Action Callback that is used when the object is successfully spawned. SpawnInfo(string, Vector3, Vector3) Initializes a new SpawnInfo. public SpawnInfo(string classId, Vector3 spawnPosition, Vector3 rotation) Parameters classId string ClassID to spawn. spawnPosition Vector3 Position to spawn into. rotation Vector3 Rotation to spawn at. SpawnInfo(string, Vector3, Vector3, Vector3) Initializes a new SpawnInfo. public SpawnInfo(string classId, Vector3 spawnPosition, Vector3 rotation, Vector3 scale) Parameters classId string ClassID to spawn. spawnPosition Vector3 Position to spawn into. rotation Vector3 Rotation to spawn at. scale Vector3 Scale to spawn with. SpawnInfo(TechType, Vector3) Initializes a new SpawnInfo. public SpawnInfo(TechType techType, Vector3 spawnPosition) Parameters techType TechType TechType to spawn. spawnPosition Vector3 Position to spawn into. SpawnInfo(TechType, Vector3, Quaternion) Initializes a new SpawnInfo. public SpawnInfo(TechType techType, Vector3 spawnPosition, Quaternion rotation) Parameters techType TechType TechType to spawn. spawnPosition Vector3 Position to spawn into. rotation Quaternion Rotation to spawn at. SpawnInfo(TechType, Vector3, Quaternion, Vector3) Initializes a new SpawnInfo. public SpawnInfo(TechType techType, Vector3 spawnPosition, Quaternion rotation, Vector3 scale) Parameters techType TechType TechType to spawn. spawnPosition Vector3 Position to spawn into. rotation Quaternion Rotation to spawn at. scale Vector3 Scale to spawn with. SpawnInfo(TechType, Vector3, Quaternion, Vector3, Action) Initializes a new SpawnInfo. public SpawnInfo(TechType techType, Vector3 spawnPosition, Quaternion rotation, Vector3 scale, Action onSpawned) Parameters techType TechType TechType to spawn. spawnPosition Vector3 Position to spawn into. rotation Quaternion Rotation to spawn at. scale Vector3 Scale to spawn with. onSpawned Action Callback that is used when the object is successfully spawned. SpawnInfo(TechType, Vector3, Vector3) Initializes a new SpawnInfo. public SpawnInfo(TechType techType, Vector3 spawnPosition, Vector3 rotation) Parameters techType TechType TechType to spawn. spawnPosition Vector3 Position to spawn into. rotation Vector3 Rotation to spawn at. SpawnInfo(TechType, Vector3, Vector3, Vector3) Initializes a new SpawnInfo. public SpawnInfo(TechType techType, Vector3 spawnPosition, Vector3 rotation, Vector3 scale) Parameters techType TechType TechType to spawn. spawnPosition Vector3 Position to spawn into. rotation Vector3 Rotation to spawn at. scale Vector3 Scale to spawn with. Methods Equals(SpawnInfo) Indicates whether the current SpawnInfo is equal to another. public bool Equals(SpawnInfo other) Parameters other SpawnInfo The other SpawnInfo. Returns bool true if the current SpawnInfo is equal to the other parameter; otherwise false. Remarks It is worth noting that we use Unity's UnityEngine.Vector3.operator ==(UnityEngine.Vector3, UnityEngine.Vector3) and UnityEngine.Quaternion.operator ==(UnityEngine.Quaternion, UnityEngine.Quaternion) operator comparisons for comparing the SpawnPosition and Rotation properties of each instance, to allow for an approximate comparison of these values. Equals(object) Indicates whether this instance and a specified object are equal. public override bool Equals(object obj) Parameters obj object The object to compare with the current instance. Returns bool true if obj is a SpawnInfo and represents the same value as this instance; otherwise, false. Remarks It is worth noting that we use Unity's UnityEngine.Vector3.operator ==(UnityEngine.Vector3, UnityEngine.Vector3) and UnityEngine.Quaternion.operator ==(UnityEngine.Quaternion, UnityEngine.Quaternion) operator comparisons for comparing the SpawnPosition and Rotation properties of each instance, to allow for an approximate comparison of these values. See Also Equals(SpawnInfo) GetHashCode() A custom hash code algorithm that takes into account the values of each property of the SpawnInfo instance, and attempts to reduce diagonal collisions. public override int GetHashCode() Returns int A 32-bit signed integer that is the hash code for this instance. Operators operator ==(SpawnInfo, SpawnInfo) Indicates whether two SpawnInfo instances are equal. public static bool operator ==(SpawnInfo a, SpawnInfo b) Parameters a SpawnInfo The first instance to compare. b SpawnInfo The second instance to compare. Returns bool true if the SpawnInfo instances are equal; otherwise, false. See Also operator !=(SpawnInfo, SpawnInfo) Equals(SpawnInfo) operator !=(SpawnInfo, SpawnInfo) Indicates whether two SpawnInfo instances are not equal. public static bool operator !=(SpawnInfo a, SpawnInfo b) Parameters a SpawnInfo The first instance to compare. b SpawnInfo The second instance to compare. Returns bool true if the SpawnInfo instances are not equal; otherwise, false. See Also operator ==(SpawnInfo, SpawnInfo) Equals(SpawnInfo)" }, "api/Nautilus.Handlers.SpriteHandler.html": { "href": "api/Nautilus.Handlers.SpriteHandler.html", diff --git a/public/days_one.ttf b/public/days_one.ttf new file mode 100644 index 000000000..ef77473c6 Binary files /dev/null and b/public/days_one.ttf differ diff --git a/public/main.css b/public/main.css old mode 100755 new mode 100644 index e69de29bb..717703ddb --- a/public/main.css +++ b/public/main.css @@ -0,0 +1,39 @@ +@font-face { + font-family: Days One; + src: url("days_one.ttf"); +} + +.lang-diff-rem { + color: rgb(236, 89, 117); +} + +.lang-diff-add { + color: rgb(62, 175, 124); +} + +@media (min-width: 1600px) { + .container { + width: 100%; + } + .sidefilter { + width: 18%; + } + .sidetoc { + width: 18%; + } + .article.grid-right { + margin-left: 19%; + } + .sideaffix { + width: 11.5%; + } + .affix ul>li.active>a { + white-space: initial; + } + .affix ul>li>a { + width: 99%; + overflow: hidden; + white-space: nowrap; + text-overflow: ellipsis; + } +} \ No newline at end of file diff --git a/xrefmap.yml b/xrefmap.yml index e0e164041..02ffe8e47 100644 --- a/xrefmap.yml +++ b/xrefmap.yml @@ -6338,6 +6338,15 @@ references: fullName.vb: Nautilus.Handlers.SpawnInfo.New(String, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Vector3) nameWithType: SpawnInfo.SpawnInfo(string, Vector3, Quaternion, Vector3) nameWithType.vb: SpawnInfo.New(String, Vector3, Quaternion, Vector3) +- uid: Nautilus.Handlers.SpawnInfo.#ctor(System.String,UnityEngine.Vector3,UnityEngine.Quaternion,UnityEngine.Vector3,System.Action{UnityEngine.GameObject}) + name: SpawnInfo(string, Vector3, Quaternion, Vector3, Action) + href: api/Nautilus.Handlers.SpawnInfo.html#Nautilus_Handlers_SpawnInfo__ctor_System_String_UnityEngine_Vector3_UnityEngine_Quaternion_UnityEngine_Vector3_System_Action_UnityEngine_GameObject__ + commentId: M:Nautilus.Handlers.SpawnInfo.#ctor(System.String,UnityEngine.Vector3,UnityEngine.Quaternion,UnityEngine.Vector3,System.Action{UnityEngine.GameObject}) + name.vb: New(String, Vector3, Quaternion, Vector3, Action(Of GameObject)) + fullName: Nautilus.Handlers.SpawnInfo.SpawnInfo(string, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Vector3, System.Action) + fullName.vb: Nautilus.Handlers.SpawnInfo.New(String, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Vector3, System.Action(Of UnityEngine.GameObject)) + nameWithType: SpawnInfo.SpawnInfo(string, Vector3, Quaternion, Vector3, Action) + nameWithType.vb: SpawnInfo.New(String, Vector3, Quaternion, Vector3, Action(Of GameObject)) - uid: Nautilus.Handlers.SpawnInfo.#ctor(System.String,UnityEngine.Vector3,UnityEngine.Vector3) name: SpawnInfo(string, Vector3, Vector3) href: api/Nautilus.Handlers.SpawnInfo.html#Nautilus_Handlers_SpawnInfo__ctor_System_String_UnityEngine_Vector3_UnityEngine_Vector3_ @@ -6383,6 +6392,15 @@ references: fullName.vb: Nautilus.Handlers.SpawnInfo.New(TechType, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Vector3) nameWithType: SpawnInfo.SpawnInfo(TechType, Vector3, Quaternion, Vector3) nameWithType.vb: SpawnInfo.New(TechType, Vector3, Quaternion, Vector3) +- uid: Nautilus.Handlers.SpawnInfo.#ctor(TechType,UnityEngine.Vector3,UnityEngine.Quaternion,UnityEngine.Vector3,System.Action{UnityEngine.GameObject}) + name: SpawnInfo(TechType, Vector3, Quaternion, Vector3, Action) + href: api/Nautilus.Handlers.SpawnInfo.html#Nautilus_Handlers_SpawnInfo__ctor_TechType_UnityEngine_Vector3_UnityEngine_Quaternion_UnityEngine_Vector3_System_Action_UnityEngine_GameObject__ + commentId: M:Nautilus.Handlers.SpawnInfo.#ctor(TechType,UnityEngine.Vector3,UnityEngine.Quaternion,UnityEngine.Vector3,System.Action{UnityEngine.GameObject}) + name.vb: New(TechType, Vector3, Quaternion, Vector3, Action(Of GameObject)) + fullName: Nautilus.Handlers.SpawnInfo.SpawnInfo(TechType, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Vector3, System.Action) + fullName.vb: Nautilus.Handlers.SpawnInfo.New(TechType, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Vector3, System.Action(Of UnityEngine.GameObject)) + nameWithType: SpawnInfo.SpawnInfo(TechType, Vector3, Quaternion, Vector3, Action) + nameWithType.vb: SpawnInfo.New(TechType, Vector3, Quaternion, Vector3, Action(Of GameObject)) - uid: Nautilus.Handlers.SpawnInfo.#ctor(TechType,UnityEngine.Vector3,UnityEngine.Vector3) name: SpawnInfo(TechType, Vector3, Vector3) href: api/Nautilus.Handlers.SpawnInfo.html#Nautilus_Handlers_SpawnInfo__ctor_TechType_UnityEngine_Vector3_UnityEngine_Vector3_