Include directive - Revision history

Sunjammer: /* Remarks */ Fixing a typo

2015-01-03T02:09:13Z

‎Remarks: Fixing a typo

Sunjammer: /* Remarks */ Fixing formatting

2012-03-01T19:29:00Z

‎Remarks: Fixing formatting

Sunjammer: /* Remarks */ Fixing typo

2012-03-01T19:26:49Z

‎Remarks: Fixing typo

Sunjammer: /* Remarks */ Fixing link

2012-03-01T13:37:13Z

‎Remarks: Fixing link

Sunjammer: Created

2012-03-01T13:36:04Z

Created

New page

The [[include directive]], <code>#include</code>, instructs the compiler to treat the contents of the specified file as if those contents had been inserted in the source script at the point where the directive appears.

<dascript>
#include "<script_resref>"
</dascript>

== Remarks ==

[[Scripting terminology#constants|Constants]], [[Scripting terminology#function|functions]] and [[struct keyword|structs]] can be organised in separate scripts or code libraries, known as "include files" to allow code to be reused in different scripts without having to retype the code multiple times.

Include files are not executable scripts, in other words they will not contain a <code>void main()</code> or a <code>int StartingConditional</code> function. As a result include files do not compile and do not produce a [[NCS|.ncs]] file. In fact when saving or attempting to compile an include file the Toolset will post a warning entry in the [[Log panel|log]] to this effect however this warning can be ignored. Sometimes an include file will have an empty <code>main</code> function commented out near the start or end of the script as the author may have used it during development to check for syntax errors.

Include files can be "nested", that is, an <code>#include</code> directive can appear in a script which is itself referenced by another <code>#include</code> directive. For example [[core_h]] and [[log_h]] are included in [[events_h]] which in turn is included in [[ability_h]]. Including <code>ability_h</code> in a script provides access to all of the constants, functions and structs in each of these include files in the hierarchy.

An include file is automatically created and maintained for every [[plot]] resources even though it does not appear in the [[script]] [[resource palette]]. The naming convention for these include files is to prefix the plot's [Scripting terminology#resref|resref]] with <code>plt_</code>. The include file contains a [[string keyword|string]] constant for the plot's GUID and [[int keyword|int]] constants for each of the plot flags.



[[Category:Directives]]

@@ Line 13: / Line 13: @@
 Include files can be ''nested'', that is, an <code>#include</code> directive can appear in a script which is itself referenced by another <code>#include</code> directive. For example [[core_h]] and [[log_h]] are included in [[events_h]] which in turn is included in [[ability_h]]. Including <code>ability_h</code> in a script provides access to all of the constants, functions and structs in each of these include files in the hierarchy.
-An include file is automatically created and maintained for every [[plot]] resources even though it does not appear in the [[script]] [[resource palette]]. The naming convention for these include files is to prefix the plot's [[Scripting terminology#Resref|resref]] with <code>plt_</code>. The include file contains a [[string keyword|string]] constant for the plot's GUID and [[int keyword|int]] constants for each of the plot flags.
+An include file is automatically created and maintained for every [[plot]] resource even though it does not appear in the [[script]] [[resource palette]]. The naming convention for these include files is to prefix the plot's [[Scripting terminology#Resref|resref]] with <code>plt_</code>. The include file contains a [[string keyword|string]] constant for the plot's GUID and [[int keyword|int]] constants for each of the plot flags.
 <!-- == Examples == -->
 <!-- == See also == -->
 [[Category:Directives]]

@@ Line 7: / Line 7: @@
 == Remarks ==
-[[Scripting terminology#Constants|Constants]], [[Scripting terminology#Function|functions]] and [[struct keyword|structs]] can be organised in separate scripts or code libraries, known as "include files" to allow code to be reused in different scripts without having to retype the code multiple times.
+[[Scripting terminology#Constants|Constants]], [[Scripting terminology#Function|functions]] and [[struct keyword|structs]] can be organised in separate scripts or code libraries, known as ''include files'', to allow code to be reused in different scripts without having to retype the code multiple times.
 Include files are not executable scripts, in other words they will not contain a <code>void main()</code> or a <code>int StartingConditional()</code> function. As a result include files do not compile and do not produce a [[NCS|.ncs]] file. In fact when saving or attempting to compile an include file the Toolset will post a warning entry in the [[Log panel|log]] to this effect however this warning can be ignored. Sometimes an include file will have an empty <code>main</code> function commented out near the start or end of the script as the author may have used it during development to check for syntax errors.
-Include files can be "nested", that is, an <code>#include</code> directive can appear in a script which is itself referenced by another <code>#include</code> directive. For example [[core_h]] and [[log_h]] are included in [[events_h]] which in turn is included in [[ability_h]]. Including <code>ability_h</code> in a script provides access to all of the constants, functions and structs in each of these include files in the hierarchy.
+Include files can be ''nested'', that is, an <code>#include</code> directive can appear in a script which is itself referenced by another <code>#include</code> directive. For example [[core_h]] and [[log_h]] are included in [[events_h]] which in turn is included in [[ability_h]]. Including <code>ability_h</code> in a script provides access to all of the constants, functions and structs in each of these include files in the hierarchy.
 An include file is automatically created and maintained for every [[plot]] resources even though it does not appear in the [[script]] [[resource palette]]. The naming convention for these include files is to prefix the plot's [[Scripting terminology#Resref|resref]] with <code>plt_</code>. The include file contains a [[string keyword|string]] constant for the plot's GUID and [[int keyword|int]] constants for each of the plot flags.

@@ Line 9: / Line 9: @@
 [[Scripting terminology#Constants|Constants]], [[Scripting terminology#Function|functions]] and [[struct keyword|structs]] can be organised in separate scripts or code libraries, known as "include files" to allow code to be reused in different scripts without having to retype the code multiple times.
-Include files are not executable scripts, in other words they will not contain a <code>void main()</code> or a <code>int StartingConditional</code> function. As a result include files do not compile and do not produce a [[NCS|.ncs]] file. In fact when saving or attempting to compile an include file the Toolset will post a warning entry in the [[Log panel|log]] to this effect however this warning can be ignored. Sometimes an include file will have an empty <code>main</code> function commented out near the start or end of the script as the author may have used it during development to check for syntax errors.
+Include files are not executable scripts, in other words they will not contain a <code>void main()</code> or a <code>int StartingConditional()</code> function. As a result include files do not compile and do not produce a [[NCS|.ncs]] file. In fact when saving or attempting to compile an include file the Toolset will post a warning entry in the [[Log panel|log]] to this effect however this warning can be ignored. Sometimes an include file will have an empty <code>main</code> function commented out near the start or end of the script as the author may have used it during development to check for syntax errors.
 Include files can be "nested", that is, an <code>#include</code> directive can appear in a script which is itself referenced by another <code>#include</code> directive. For example [[core_h]] and [[log_h]] are included in [[events_h]] which in turn is included in [[ability_h]]. Including <code>ability_h</code> in a script provides access to all of the constants, functions and structs in each of these include files in the hierarchy.