Script Modding Guide - Revision history

Xarkanoth at 10:54, 18 September 2025

2025-09-18T10:54:13Z

Xarkanoth at 10:44, 18 September 2025

2025-09-18T10:44:13Z

Xarkanoth at 10:41, 18 September 2025

2025-09-18T10:41:42Z

Xarkanoth: Replaced content with "{{ContentTemplateModernInline | welcome = Getting Started | blurb = Set up your environment, understand core concepts, and ship your first Holdfast script mod. | sec..."

2025-09-18T10:36:01Z

Replaced content with "{{ContentTemplateModernInline | welcome = Getting Started | blurb = Set up your environment, understand core concepts, and ship your first Holdfast script mod. | sec..."

Show changes

Xarkanoth at 10:26, 18 September 2025

2025-09-18T10:26:21Z

Show changes

Xarkanoth at 10:24, 18 September 2025

2025-09-18T10:24:46Z

Xarkanoth at 10:23, 18 September 2025

2025-09-18T10:23:42Z

Show changes

Xarkanoth: /* Main Canvas GameObjects */

2025-06-22T16:01:58Z

Main Canvas GameObjects

Xarkanoth: /* List of GameObjects */

2025-06-22T15:57:48Z

List of GameObjects

Xarkanoth: /* SharedMethods Copy/Paste */

2025-06-22T15:51:18Z

SharedMethods Copy/Paste

@@ Line 30: / Line 30: @@
   | featured_title   = Gameplay
- | featured_content = {{:{{FULLPAGENAME}}/Body}}   <!-- auto-resolves the correct /Body -->
+| featured_content = {{:{{FULLPAGENAME}}/Body}}
   | image_content    =

@@ Line 30: / Line 30: @@
   | featured_title   = Gameplay
-  | featured_content = {{:Script Modding Guide/Body}}   <!-- use THIS page’s /Body -->
+  | featured_content = {{:{{FULLPAGENAME}}/Body}}   <!-- auto-resolves the correct /Body -->
-  | image_content   =
+  | image_content    =
   | layout          = auto
   | two_col         = no

@@ Line 30: / Line 30: @@
   | featured_title   = Gameplay
-  | featured_content = {{:Getting Started/Body}}
+  | featured_content = {{:Script Modding Guide/Body}}   <!-- use THIS page’s /Body -->
   | layout          = auto
   | two_col         = no

@@ Line 244: / Line 244: @@
 ==== OnShotInfo ====
 The game will call this when a bullet.
-Note: This requires `rc set drawFirearmTajectories true` or `rc set drawFirearmTajectories
+Note: This requires `rc set drawFirearmTajectories true` or `rc set drawFirearmTajectoriesInfo true`.

@@ Line 610: / Line 610: @@
 |-
 |Controls Notification Popup
+|
 |}

@@ Line 486: / Line 486: @@
 [[File:Finding Main Canvas.png|center|thumb|450x450px]]
-=== List of GameObjects ===
+=== ClientScene GameObjects ===
-{| class="wikitable sortable mw-collapsible"
+{| class="wikitable"
 !Name
 !Under
@@ Line 525: / Line 525: @@
 |-
 |Menu Canvas
-|Client Scene
+|ClientScene
+|
 |-
 |Player Name Tags
+|
 |-
 |Priority Name Tag Canvas
+|
 |-
 |Spyglass Lens Panel
+|
 |-
 |Settings Loading Black Background
+|
 |-
 |End of Round Panel
+|
 |-
 |End of Match Panel
+|
 |-
 |End of Match Panel
+|
 |-
 |Game Elements Panel
+|
 |-
 |New Player Joined Notification Panel
+|
 |-
 |Free Roam Panel
+|
 |-
 |Death Screen Panel
+|
 |-
 |Spectating Panel
+|
 |-
 |Top Info Bar
-|Main Canvas
+|Turning off the Top Info Bar will result in it being turned back on automatically.
 |-
 |Kill Log Panel
+|
 |-
 |UI Proxy Player Card Container Panel
+|
 |-
 |Main Respawn Timer Container
+|
 |-
 |P Menu Panel
+|
 |-
 |Round Players Control Panel - Dialog Box
+|
 |-
 |Report Submitted Popup
+|
 |-
 |New Scoreboard Panel
+|
 |-
 |Round End Panel
+|
 |-
 |New Chat Panel
+|
 |-
 |VOIP Elements Panel
+|
 |-
 |Poll Voting Panel
+|
 |-
 |In-game Server Details Panel
+|
 |-
 |Controls Notification Popup
+|
 |}

← Older revision		Revision as of 15:51, 22 June 2025
Line 464:		Line 464:

	https://github.com/Xarkanoth/Holdfast-Scripts/tree/main/IHoldfastSharedMethods		https://github.com/Xarkanoth/Holdfast-Scripts/tree/main/IHoldfastSharedMethods
		+
		+	= Key Scene GameObjects =
		+	When developing client-side mods, you will often need to find and interact with specific <code>GameObjects</code> that are part of the game's scene. Knowing the names of these objects and how to access them is essential for tasks like creating custom UI and manipulating cameras.
		+
		+	Note: GameObject names can change at any time with no update regarding the name change.
		+
		+	==== The Main Camera: <code>Main Camera SCENE</code> ====
		+	This is the primary camera that renders the player's view. You might interact with it to get its position, change its field of view, or attach custom visual effects.
		+
		+	* Name: <code>Main Camera SCENE</code>
		+	* Example: Finding the Main Camera
		+
		+	[[File:Main Camera SCENE.png\|center\|thumb\|482x482px]]
		+
		+	==== The Main UI Canvas: <code>Main Canvas</code> ====
		+	This GameObject is the root of most of Holdfast's user interface. If you want to add your own UI elements (like panels, text, or images), you will typically make them children of this canvas to ensure they are rendered correctly on the player's screen.
		+
		+	* Name: <code>Main Canvas</code>
		+	* Example: Finding the Main Canvas
		+
		+	[[File:Finding Main Canvas.png\|center\|thumb\|450x450px]]
		+
		+	=== List of GameObjects ===
		+	{\| class="wikitable sortable mw-collapsible"
		+	!Name
		+	!Under
		+	!Description
		+	\|-
		+	\|Post Processing Global Volume
		+	\|ClientScene
		+	\|
		+	\|-
		+	\|MasterAudio - Client Scene
		+	\|ClientScene
		+	\|
		+	\|-
		+	\|Nature Renderer Global Settings
		+	\|ClientScene
		+	\|
		+	\|-
		+	\|Scripts
		+	\|ClientScene
		+	\|
		+	\|-
		+	\|Audio Listener
		+	\|ClientScene
		+	\|
		+	\|-
		+	\|WindZone
		+	\|ClientScene
		+	\|
		+	\|-
		+	\|Camera - Client
		+	\|ClientScene
		+	\|
		+	\|-
		+	\|Main Canvas
		+	\|ClientScene
		+	\|The UI panel that players see in-game.
		+	\|-
		+	\|Menu Canvas
		+	\|Client Scene
		+	\|
		+	\|-
		+	\|Player Name Tags
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|Priority Name Tag Canvas
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|Spyglass Lens Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|Settings Loading Black Background
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|End of Round Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|End of Match Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|End of Match Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|Game Elements Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|New Player Joined Notification Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|Free Roam Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|Death Screen Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|Spectating Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|Top Info Bar
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|Kill Log Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|UI Proxy Player Card Container Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|Main Respawn Timer Container
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|P Menu Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|Round Players Control Panel - Dialog Box
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|Report Submitted Popup
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|New Scoreboard Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|Round End Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|New Chat Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|VOIP Elements Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|Poll Voting Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|In-game Server Details Panel
		+	\|Main Canvas
		+	\|
		+	\|-
		+	\|Controls Notification Popup
		+	\|Main Canvas
		+	\|
		+	\|}

	= Code Examples & Resources =		= Code Examples & Resources =