Hooks - Revision history

Thyraxx.void at 21:20, 29 August 2023

2023-08-29T21:20:14Z

← Older revision		Revision as of 23:20, 29 August 2023
Line 61:		Line 61:

	== GameModeRenderFrame ==		== GameModeRenderFrame ==
	void ~~GameModePreRenderFrame~~(BaseGameMode@ baseGameMode, int idt, SpriteBatch& sb)		void GameModeRenderFrame(BaseGameMode@ baseGameMode, int idt, SpriteBatch& sb)

	== GameModeStart ==		== GameModeStart ==

KellyFromSales at 22:30, 19 August 2023

2023-08-19T22:30:23Z

← Older revision		Revision as of 00:30, 20 August 2023
Line 76:		Line 76:
	void GameModeSpawnPlayerCorpse(BaseGameMode@ baseGameMode, PlayerRecord@ record)		void GameModeSpawnPlayerCorpse(BaseGameMode@ baseGameMode, PlayerRecord@ record)
	Called when a player corpse is spawned.		Called when a player corpse is spawned.


			{{Template:BaseNav}}

Thyraxx.void at 17:35, 4 August 2023

2023-08-04T17:35:00Z

@@ Line 49: / Line 49: @@
   void PlayerMenuConstructor(PlayerMenu@ menu)
-== GameModeUpdate==
+== GameModeUpdate ==
-  void GameModeUpdate(BaseGameMode@ baseGameMode, int ms, GameInput& gameInput, MenuInput& menuInput);
+  void GameModeUpdate(BaseGameMode@ baseGameMode, int ms, GameInput& gameInput, MenuInput& menuInput)
-Called every frameupdate.
+Called every frame update.

Thyraxx.void at 17:22, 4 August 2023

2023-08-04T17:22:07Z

← Older revision		Revision as of 19:22, 4 August 2023
Line 48:		Line 48:
	== PlayerMenuConstructor ==		== PlayerMenuConstructor ==
	void PlayerMenuConstructor(PlayerMenu@ menu)		void PlayerMenuConstructor(PlayerMenu@ menu)

			== GameModeUpdate==
			void GameModeUpdate(BaseGameMode@ baseGameMode, int ms, GameInput& gameInput, MenuInput& menuInput);
			Called every frameupdate.

KellyFromSales at 13:16, 16 July 2023

2023-07-16T13:16:24Z

← Older revision		Revision as of 15:16, 16 July 2023
Line 46:		Line 46:
	void LevelupCharacter(PlayerRecord@ record)		void LevelupCharacter(PlayerRecord@ record)

	== "PlayerMenuConstructor ==		== PlayerMenuConstructor ==
	void PlayerMenuConstructor(PlayerMenu@ menu)		void PlayerMenuConstructor(PlayerMenu@ menu)

KellyFromSales at 13:16, 16 July 2023

2023-07-16T13:16:12Z

← Older revision		Revision as of 15:16, 16 July 2023
Line 11:		Line 11:
	print("Hello World");		print("Hello World");
	}		}

	}		}

KellyFromSales at 13:14, 16 July 2023

2023-07-16T13:14:46Z

← Older revision		Revision as of 15:14, 16 July 2023
Line 1:		Line 1:
	~~Code hooks~~, ~~for example:~~		Hooks are script functions that are called at specific moments. This way, you can insert code into the game.

	<~~nowiki~~>		They are specified in script files and tagged with the <code>Hook</code> specifier. They also must be placed within a namespace to avoid ambiguity between multiple mods.
	namespace ~~fasttraveltab~~
	{		The following is an example of such a file:

			namespace MyTestMod
			{
	[Hook]		[Hook]
	void ~~PlayerMenuConstructor~~(~~PlayerMenu~~@ ~~menu~~) {		void BaseGameModeConstructor(BaseGameMode@ baseGameMode){
	~~menu.m_tabSystem.AddTab~~(~~PlayerMenuFasttravelTab()~~);		print("Hello World");
	}		}
	}
	~~</nowiki>~~

			}

			== BaseGameModeConstructor ==
			void BaseGameModeConstructor(BaseGameMode@ basegamemode)
			Called when the gamemode is being constructed. Useful for initial setting up, for example to add new definitions for items, cvars etc.

	~~Current hooks are:~~		== PlayerRecordSave ==
			void PlayerRecordSave(PlayerRecord@ record, SValueBuilder &builder)
			Called when a player record is being saved. Use <code>builder</code> to serialize data.

	~~PlayerRefreshScene~~		== PlayerRecordLoad ==
			void PlayerRecordLoad(PlayerRecord@ record, SValue@ sval)
			Called when a player record is being loaded. Use <code>sval</code> to deserialize data.

	~~PlayerRecordConstructor~~		== PlayerRecordRefreshModifiers ==
			void PlayerRecordRefreshModifiers(PlayerRecord@ record)
			Called when modifiers are refreshed in a player record.

	~~PlayerRecordSave~~		== CreateCharacter ==
			void CreateCharacter(PlayerRecord@ record)
			Called when Character Creation is initialized.

	~~PlayerRecordRefreshModifiers~~		== LoadWidgetProducers ==
			void LoadWidgetProducers(GUIBuilder@ builder)
			Called when widget producers should be loaded. This allows you to initialize custom widget producers that can produce custom widgets. <code>builder</code> is where you would call <code>AddWidgetProducer</code> on to initialize the widget producer.

	~~CreateCharacter~~		== HUDConstructor ==
			void HUDConstructor(HUD@ hud, GUIBuilder@ b)

	~~BaseGameModeConstructor~~		== PlayerRefreshScene ==
			void PlayerRefreshScene(PlayerBase@ player)

	~~HUDConstructor~~		== LevelupCharacter ==
			void LevelupCharacter(PlayerRecord@ record)

	~~LoadWidgetProducers~~		== "PlayerMenuConstructor ==
			void PlayerMenuConstructor(PlayerMenu@ menu)

KellyFromSales: Created page with "Code hooks, for example: namespace fasttraveltab { [Hook] void PlayerMenuConstructor(PlayerMenu@ menu) { menu.m_tabSystem.AddTab(PlayerMenuFasttravelTab()); } } Current hooks are: PlayerRefreshScene PlayerRecordConstructor PlayerRecordSave PlayerRecordRefreshModifiers CreateCharacter BaseGameModeConstructor HUDConstructor LoadWidgetProducers"

2023-07-16T12:30:08Z

Created page with "Code hooks, for example: <nowiki> namespace fasttraveltab { [Hook] void PlayerMenuConstructor(PlayerMenu@ menu) { menu.m_tabSystem.AddTab(PlayerMenuFasttravelTab()); } } </nowiki> Current hooks are: PlayerRefreshScene PlayerRecordConstructor PlayerRecordSave PlayerRecordRefreshModifiers CreateCharacter BaseGameModeConstructor HUDConstructor LoadWidgetProducers"

New page

Code hooks, for example:

<nowiki>
namespace fasttraveltab
{
[Hook]
void PlayerMenuConstructor(PlayerMenu@ menu) {
menu.m_tabSystem.AddTab(PlayerMenuFasttravelTab());
}
}
</nowiki>

Current hooks are:

PlayerRefreshScene

PlayerRecordConstructor

PlayerRecordSave

PlayerRecordRefreshModifiers

CreateCharacter

BaseGameModeConstructor

HUDConstructor

LoadWidgetProducers