Advanced SCI Tutorials - SCI Memory Management - Revision history

Andrew Branscom: /* Introduction */

2025-04-29T18:39:13Z

Introduction

← Older revision		Revision as of 13:39, 29 April 2025
Line 8:		Line 8:
	==<br /> Introduction ==		==<br /> Introduction ==

	<div align="center">[[Image:SCIOutOfHeap.png\|Out of Heap]]</div>		<div align="center">[[Image:SCIOutOfHeap.png\|Out of Heap]]</div><br />

	The dreaded "Out of heap space" message. If you have been making a game long enough, you have probably encountered this issue. The bad news is, this seemingly random message stops your game cold. The good news is, you can probably fix the issue, and make your memory management very predictable.		The dreaded "Out of heap space" message. If you have been making a game long enough, you have probably encountered this issue. The bad news is, this seemingly random message stops your game cold. The good news is, you can probably fix the issue, and make your memory management very predictable.

Andrew Branscom at 18:38, 29 April 2025

2025-04-29T18:38:55Z

← Older revision		Revision as of 13:38, 29 April 2025
Line 3:		Line 3:
	[[SCI Tutorials and Guides\|SCI Tutorials and Guides Table of Contents]]		[[SCI Tutorials and Guides\|SCI Tutorials and Guides Table of Contents]]

	<div align="center"><span style="font-size: 22pt">Chapter 7 - SCI Memory management</span><br />''By [[]]''</div>		<div align="center"><span style="font-size: 22pt">Chapter 6 - SCI Memory management</span><br />''By [[]]''</div>

	<br />		<br />
Line 123:		Line 123:
	*		*

	<span style="float: left">[[Advanced SCI Tutorials - The z-coordinate\|< Previous: Chapter 6 - The z-coordinate]]</span>		<span style="float: left">[[Advanced SCI Tutorials - The z-coordinate\|< Previous: Chapter 5 - The z-coordinate]]</span>
	<span style="float: right">[[Advanced SCI Tutorials - Advanced Use of Control Areas\|Next: Chapter 8 - Advanced Use of Control Areas >]]</span>		<span style="float: right">[[Advanced SCI Tutorials - Advanced Use of Control Areas\|Next: Chapter 7 - Advanced Use of Control Areas >]]</span>

	[[Category:Technical Info]]		[[Category:Technical Info]]

Andrew Branscom at 18:37, 29 April 2025

2025-04-29T18:37:45Z

← Older revision		Revision as of 13:37, 29 April 2025
Line 4:		Line 4:

	<div align="center"><span style="font-size: 22pt">Chapter 7 - SCI Memory management</span><br />''By [[]]''</div>		<div align="center"><span style="font-size: 22pt">Chapter 7 - SCI Memory management</span><br />''By [[]]''</div>

	~~<div align="center">[[Image:SCIOutOfHeap.png\|Out of Heap]]</div>~~

	<br />		<br />
	==<br /> Introduction ==		==<br /> Introduction ==

			<div align="center">[[Image:SCIOutOfHeap.png\|Out of Heap]]</div>

	The dreaded "Out of heap space" message. If you have been making a game long enough, you have probably encountered this issue. The bad news is, this seemingly random message stops your game cold. The good news is, you can probably fix the issue, and make your memory management very predictable.		The dreaded "Out of heap space" message. If you have been making a game long enough, you have probably encountered this issue. The bad news is, this seemingly random message stops your game cold. The good news is, you can probably fix the issue, and make your memory management very predictable.
Line 127:		Line 127:

	[[Category:Technical Info]]		[[Category:Technical Info]]
			[[Category:SCI Technical Info]]
	[[Category:Heap]]		[[Category:Heap]]
			[[Category:SCI Heap]]
	[[Category:Memory]]		[[Category:Memory]]
			[[Category:SCI Memory]]
	[[Category:Tutorials]]		[[Category:Tutorials]]
	[[Category:SCI Tutorials]]		[[Category:SCI Tutorials]]

Andrew Branscom at 18:36, 29 April 2025

2025-04-29T18:36:15Z

← Older revision		Revision as of 13:36, 29 April 2025
Line 4:		Line 4:

	<div align="center"><span style="font-size: 22pt">Chapter 7 - SCI Memory management</span><br />''By [[]]''</div>		<div align="center"><span style="font-size: 22pt">Chapter 7 - SCI Memory management</span><br />''By [[]]''</div>

			<div align="center">[[Image:SCIOutOfHeap.png\|Out of Heap]]</div>

	<br />		<br />
	==<br /> Introduction ==		==<br /> Introduction ==

	~~<div align="center">[[Image:SCIOutOfHeap.png\|Out of Heap]]</div>~~

	The dreaded "Out of heap space" message. If you have been making a game long enough, you have probably encountered this issue. The bad news is, this seemingly random message stops your game cold. The good news is, you can probably fix the issue, and make your memory management very predictable.		The dreaded "Out of heap space" message. If you have been making a game long enough, you have probably encountered this issue. The bad news is, this seemingly random message stops your game cold. The good news is, you can probably fix the issue, and make your memory management very predictable.

Andrew Branscom at 18:35, 29 April 2025

2025-04-29T18:35:52Z

← Older revision		Revision as of 13:35, 29 April 2025
Line 1:		Line 1:
	[[Category:SCI Pages]]		[[Category:SCI Pages]]
	= Chapter 7 - SCI Memory management =		[[Category:SCI Pages to be Edited]]
			[[SCI Tutorials and Guides\|SCI Tutorials and Guides Table of Contents]]

			<div align="center"><span style="font-size: 22pt">Chapter 7 - SCI Memory management</span><br />''By [[]]''</div>

			<br />
			==<br /> Introduction ==

	<div align="center">[[Image:SCIOutOfHeap.png\|Out of Heap]]</div>		<div align="center">[[Image:SCIOutOfHeap.png\|Out of Heap]]</div>
Line 6:		Line 12:
	The dreaded "Out of heap space" message. If you have been making a game long enough, you have probably encountered this issue. The bad news is, this seemingly random message stops your game cold. The good news is, you can probably fix the issue, and make your memory management very predictable.		The dreaded "Out of heap space" message. If you have been making a game long enough, you have probably encountered this issue. The bad news is, this seemingly random message stops your game cold. The good news is, you can probably fix the issue, and make your memory management very predictable.

	== The SCI Heap ==		==<br /> The SCI Heap ==

	To learn how to fix these problems, you must first understand how the SCI heap works.		To learn how to fix these problems, you must first understand how the SCI heap works.
Line 43:		Line 49:
	'''  '''		'''  '''

	== Heap fragmentation ==		==<br /> Heap fragmentation ==

	More than anything, the "out of heap space" error is probably caused by heap fragmentation. Consider the following scenario:		More than anything, the "out of heap space" error is probably caused by heap fragmentation. Consider the following scenario:
Line 88:		Line 94:
	It is just a bug in the template game that the '''Wander''' script isn't in that list. I think it's the only one that is missing. '''''But the take-home point is''''': if you ever add a ''new'' script resource that is used like this (like some sort of custom motion class, or object of any kind), then you will need to add your script resource number to this list as well. Locale and region scripts do not need to be added -- those are unloaded automatically by the game. But if you made a "FlyTo" motion class that was in its own script resource for example, then it should be added here.		It is just a bug in the template game that the '''Wander''' script isn't in that list. I think it's the only one that is missing. '''''But the take-home point is''''': if you ever add a ''new'' script resource that is used like this (like some sort of custom motion class, or object of any kind), then you will need to add your script resource number to this list as well. Locale and region scripts do not need to be added -- those are unloaded automatically by the game. But if you made a "FlyTo" motion class that was in its own script resource for example, then it should be added here.

	== Examining the heap ==		==<br /> Examining the heap ==

	To determine if your heap is being fragmented, you can add the following code to '''main.sc''' (or whatever room you're interested in).		To determine if your heap is being fragmented, you can add the following code to '''main.sc''' (or whatever room you're interested in).
Line 116:		Line 122:

	*		*

	<span style="float: left">[[Advanced SCI Tutorials - The z-coordinate\|< Previous: Chapter 6 - The z-coordinate]]</span>		<span style="float: left">[[Advanced SCI Tutorials - The z-coordinate\|< Previous: Chapter 6 - The z-coordinate]]</span>
	<span style="float: right">[[Advanced SCI Tutorials - Advanced Use of Control Areas\|Next: Chapter 8 - Advanced Use of Control Areas >]]</span>		<span style="float: right">[[Advanced SCI Tutorials - Advanced Use of Control Areas\|Next: Chapter 8 - Advanced Use of Control Areas >]]</span>

Andrew Branscom: /* Related Links */

2025-04-28T17:44:08Z

Andrew Branscom: Andrew Branscom moved page SCI Memory Management to Advanced SCI Tutorials - SCI Memory Management

2025-04-28T17:22:58Z

Andrew Branscom moved page SCI Memory Management to Advanced SCI Tutorials - SCI Memory Management

← Older revision	Revision as of 12:22, 28 April 2025
(No difference)

Andrew Branscom: /* Heap fragmentation */

2025-03-30T15:57:31Z

Heap fragmentation

← Older revision		Revision as of 10:57, 30 March 2025
Line 54:		Line 54:
	Now let's see what happens when the ego leaves the room. If the game unloads the room script, but leaves the '''Wander''' script behind (we'll get to why this might happen a little later), we'll have this:		Now let's see what happens when the ego leaves the room. If the game unloads the room script, but leaves the '''Wander''' script behind (we'll get to why this might happen a little later), we'll have this:

	<div align="center">[[Image:~~SCIHeap-Unload~~.png\|Heap Unload]]<br />		<div align="center">[[Image:SCIHeapUnload.png\|Heap Unload]]<br />
	Heap Unload</div>		Heap Unload</div>

Andrew Branscom: Undo revision 88019 by Andrew Branscom (talk)

2025-03-30T15:54:58Z

Undo revision 88019 by Andrew Branscom (talk)

← Older revision		Revision as of 10:54, 30 March 2025
Line 70:		Line 70:
	'''startRoom''':		'''startRoom''':
	<div class="CodeBlockHeader">Code:</div>		<div class="CodeBlockHeader">Code:</div>
	<syntaxhighlight lang="~~C++~~" class="cs"> (method (startRoom roomNum)		<syntaxhighlight lang="sci" class="cs"> (method (startRoom roomNum)
	DisposeLoad(		DisposeLoad(
	NULL		NULL
Line 94:		Line 94:
	Showing the heap usage when the user types "show memory":		Showing the heap usage when the user types "show memory":
	<div class="CodeBlockHeader">Code:</div>		<div class="CodeBlockHeader">Code:</div>
	<syntaxhighlight lang="~~C++~~" class="cs"> (if(Said('show/memory'))		<syntaxhighlight lang="sci" class="cs"> (if(Said('show/memory'))
	ShowFree()		ShowFree()
	FormatPrint(		FormatPrint(

Andrew Branscom at 15:54, 30 March 2025

2025-03-30T15:54:38Z

← Older revision		Revision as of 10:54, 30 March 2025
Line 70:		Line 70:
	'''startRoom''':		'''startRoom''':
	<div class="CodeBlockHeader">Code:</div>		<div class="CodeBlockHeader">Code:</div>
	<syntaxhighlight lang="~~sci~~" class="cs"> (method (startRoom roomNum)		<syntaxhighlight lang="C++" class="cs"> (method (startRoom roomNum)
	DisposeLoad(		DisposeLoad(
	NULL		NULL
Line 94:		Line 94:
	Showing the heap usage when the user types "show memory":		Showing the heap usage when the user types "show memory":
	<div class="CodeBlockHeader">Code:</div>		<div class="CodeBlockHeader">Code:</div>
	<syntaxhighlight lang="~~sci~~" class="cs"> (if(Said('show/memory'))		<syntaxhighlight lang="C++" class="cs"> (if(Said('show/memory'))
	ShowFree()		ShowFree()
	FormatPrint(		FormatPrint(

← Older revision		Revision as of 12:44, 28 April 2025
Line 117:		Line 117:
	*		*

	<span style="float: left">[[The z-coordinate\|< Previous: Chapter 6 - The z-coordinate]]</span>		<span style="float: left">[[Advanced SCI Tutorials - The z-coordinate\|< Previous: Chapter 6 - The z-coordinate]]</span>
	<span style="float: right">[[Advanced Use of Control Areas\|Next: Chapter 8 - Advanced Use of Control Areas >]]</span>		<span style="float: right">[[Advanced SCI Tutorials - Advanced Use of Control Areas\|Next: Chapter 8 - Advanced Use of Control Areas >]]</span>

	[[Category:Technical Info]]		[[Category:Technical Info]]