Common Includes: Difference between revisions

From Sinfar
No edit summary
(Apply approved Sinfar resource-page layout: native headings, compact tables and responsive navigation; preserve existing content.)
 
Line 1: Line 1:
<div class="sf-page sf-article-page sf-guidance-family sf-resource-page">
<div class="sf-family-path">[[Main Page|Main Page]] · [[:Category:Builders Tools|Builder resources]]</div>
<div class="sf-hero"><div class="sf-eyebrow">Builder resources · Scripting reference</div>
<div class="sf-title">Common Includes</div>
<p>Shared include files and documented helper functions.</p>
</div>
== On this page ==
<div class="sf-task-index">[[#inc_debug|inc_debug]] [[#inc_chatcmd|inc_chatcmd]] [[#x0_i0_stringlib|x0_i0_stringlib]] [[#inc_x_cstmfac|inc_x_cstmfac]] [[#pc_inc_teleport|pc_inc_teleport]]</div>
Directory of common includes which may be useful for scripters
Directory of common includes which may be useful for scripters


=== inc_debug ===
 
== inc_debug ==
 
<div class="sf-content-panel">
void Alert(string sString);
void Alert(string sString);


Line 14: Line 27:


* Builds a string of relevant information about a PC, creature or other object. Useful in a Log function, for example.
* Builds a string of relevant information about a PC, creature or other object. Useful in a Log function, for example.
</div>
== inc_chatcmd ==


=== inc_chatcmd ===
== x0_i0_stringlib ==


=== x0_i0_stringlib ===


=== inc_x_cstmfac ===
== inc_x_cstmfac ==


=== pc_inc_teleport ===


== pc_inc_teleport ==


<div class="sf-content-panel">
[[:Category:Scripting]]
[[:Category:Scripting]]
</div>
<div class="sf-footerlinks">[[Main Page|Return to Main Page]] · [[Player Guidance Directory]] · [[:Category:Builders Tools|Builder resources]]</div>
</div>

Latest revision as of 22:51, 10 November 2026

Builder resources · Scripting reference
Common Includes

Shared include files and documented helper functions.

On this page

Directory of common includes which may be useful for scripters


inc_debug

void Alert(string sString);

  • Send a debug message (See BuildDebugMessage()), to all builders that can modify this ERF and print this message in the log associated with the script

void Debug(string sString, object oBuilder=OBJECT_SELF);

  • Send a debug message (See BuildDebugMessage()), to oBuilder. If oBuilder is not a PC then the function will try to fun the best target: Master, Nearest Object
  • This function is slow and should only be use for debugging purpose.

string GetObjectDebugInfo(object oObject)

  • Builds a string of relevant information about a PC, creature or other object. Useful in a Log function, for example.

inc_chatcmd

x0_i0_stringlib

inc_x_cstmfac

pc_inc_teleport