Gittes-archive/new-horizons
2
0
Fork 0
mirror of https://github.com/Outer-Wilds-New-Horizons/new-horizons.git synced 2025-12-11 20:15:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

example

Browse Source
This commit is contained in:
Noah Pilarski 2025-02-17 01:49:32 -05:00
parent e94fc11bb9
commit 627599b71d
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/src/content/docs/guides/title-screens.md
View File

@ -146,6 +146,25 @@ UnityEvent<string> GetTitleScreenLoadedEvent();
UnityEvent GetAllTitleScreensLoadedEvent();
```
### Example usage
```csharp title="YourModBehaviour.cs"
NewHorizons = ModHelper.Interaction.TryGetModApi<INewHorizons>("xen.NewHorizons");
NewHorizons.GetTitleScreenLoadedEvent().AddListener(OnTitleScreenLoaded);
NewHorizons.GetAllTitleScreensLoadedEvent().AddListener(OnAllTitleScreensLoaded);
```
```csharp title="YourModBehaviour.cs"
public void OnTitleScreenLoaded(string modUniqueName)
{
ModHelper.Console.WriteLine($"Title screen loaded: " + modUniqueName, MessageType.Success);
}
public void OnAllTitleScreensLoaded()
{
ModHelper.Console.WriteLine($"All title screens loaded", MessageType.Success);
}
```
## Sharing
New Horizons will randomly select a valid title screen each time the user enters the main menu and then if `shareTitleScreen` is set to `true` it will build all the other shareable title screens (that also have matching `disableNHPlanets` values). If it doesn't have share set to true then it will only show the randomly selected.