View source for List of ND Script Functions

Automatically generated Squirrel functions list for {{nd|4}}.

== Classes ==
=== :: (Global functions) ===
==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>DebugDrawBox</code>
| <code>void DebugDrawBox(Vector, Vector, Vector, int, int, int, int, float)</code>
| Draw a debug overlay box
|-
| <code>DebugDrawLine</code>
| <code>void DebugDrawLine(Vector, Vector, int, int, int, bool, float)</code>
| Draw a debug overlay box
|-
| <code>DoIncludeScript</code>
| <code>bool DoIncludeScript(string, handle)</code>
| Execute a script (internal)
|-
| <code>GetConVarFloat</code>
| <code>float GetConVarFloat(string)</code>
| Retrieves a ConVar's value as a float
|-
| <code>GetConVarInt</code>
| <code>int GetConVarInt(string)</code>
| Retrieves a ConVar's value as an integer
|-
| <code>GetConVarString</code>
| <code>string GetConVarString(string)</code>
| Retrieves a ConVar's value as a string
|-
| <code>GetMapName</code>
| <code>string GetMapName()</code>
| Get the name of the map.
|-
| <code>GetTeam</code>
| <code>handle GetTeam(int)</code>
| Returns a team's handle.
|-
| <code>RandomFloat</code>
| <code>float RandomFloat(float, float)</code>
| Generate a random floating point number within a range, inclusive
|-
| <code>RandomInt</code>
| <code>int RandomInt(int, int)</code>
| Generate a random integer within a range, inclusive
|-
| <code>SendToConsole</code>
| <code>void SendToConsole(string)</code>
| Send a string to the console as a command
|-
| <code>SetConVarFloat</code>
| <code>void SetConVarFloat(string, float)</code>
| Sets a ConVar's value from a float
|-
| <code>SetConVarInt</code>
| <code>void SetConVarInt(string, int)</code>
| Sets a ConVar's value from an integer
|-
| <code>SetConVarString</code>
| <code>void SetConVarString(string, string)</code>
| Sets a ConVar's value from a string
|-
| <code>ShowMessage</code>
| <code>void ShowMessage(string)</code>
| Print a hud message on all clients
|-
| <code>Time</code>
| <code>float Time()</code>
| Get the current server time
|}
=== CBaseEntity ===
==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>CBaseEntity::ConnectOutput</code>
| <code>void CBaseEntity::ConnectOutput(string, string)</code>
| Adds an I/O connection that will call the named function when the specified output fires
|-
| <code>CBaseEntity::DisconnectOutput</code>
| <code>void CBaseEntity::DisconnectOutput(string, string)</code>
| Removes a connected script function from an I/O event.
|-
| <code>CBaseEntity::FirstMoveChild</code>
| <code>handle CBaseEntity::FirstMoveChild()</code>
| 
|-
| <code>CBaseEntity::GetClassname</code>
| <code>string CBaseEntity::GetClassname()</code>
| 
|-
| <code>CBaseEntity::GetForwardVector</code>
| <code>Vector CBaseEntity::GetForwardVector()</code>
| Get the forward vector of the entity
|-
| <code>CBaseEntity::GetHealth</code>
| <code>int CBaseEntity::GetHealth()</code>
| 
|-
| <code>CBaseEntity::GetLifeState</code>
| <code>int CBaseEntity::GetLifeState()</code>
| 
|-
| <code>CBaseEntity::GetMaxHealth</code>
| <code>int CBaseEntity::GetMaxHealth()</code>
| 
|-
| <code>CBaseEntity::GetMoveParent</code>
| <code>handle CBaseEntity::GetMoveParent()</code>
| If in hierarchy, retrieves the entity's parent
|-
| <code>CBaseEntity::GetName</code>
| <code>string CBaseEntity::GetName()</code>
| 
|-
| <code>CBaseEntity::GetOrigin</code>
| <code>Vector CBaseEntity::GetOrigin()</code>
| 
|-
| <code>CBaseEntity::GetPreTemplateName</code>
| <code>string CBaseEntity::GetPreTemplateName()</code>
| Get the entity name stripped of template unique decoration
|-
| <code>CBaseEntity::GetRootMoveParent</code>
| <code>handle CBaseEntity::GetRootMoveParent()</code>
| If in hierarchy, walks up the hierarchy to find the root parent
|-
| <code>CBaseEntity::GetScriptId</code>
| <code>string CBaseEntity::GetScriptId()</code>
| Retrieve the unique identifier used to refer to the entity within the scripting system
|-
| <code>CBaseEntity::GetScriptScope</code>
| <code>handle CBaseEntity::GetScriptScope()</code>
| Retrieve the script-side data associated with an entity
|-
| <code>CBaseEntity::GetTeam</code>
| <code>handle CBaseEntity::GetTeam()</code>
| 
|-
| <code>CBaseEntity::GetTeamNumber</code>
| <code>int CBaseEntity::GetTeamNumber()</code>
| 
|-
| <code>CBaseEntity::GetVelocity</code>
| <code>Vector CBaseEntity::GetVelocity()</code>
| 
|-
| <code>CBaseEntity::NextMovePeer</code>
| <code>handle CBaseEntity::NextMovePeer()</code>
| 
|-
| <code>CBaseEntity::SetAbsOrigin</code>
| <code>void CBaseEntity::SetAbsOrigin(Vector)</code>
| SetAbsOrigin
|-
| <code>CBaseEntity::SetForwardVector</code>
| <code>void CBaseEntity::SetForwardVector(Vector)</code>
| Set the orientation of the entity to have this forward vector
|-
| <code>CBaseEntity::SetHealth</code>
| <code>void CBaseEntity::SetHealth(int)</code>
| 
|-
| <code>CBaseEntity::SetOrigin</code>
| <code>void CBaseEntity::SetOrigin(Vector)</code>
| 
|-
| <code>CBaseEntity::SetVelocity</code>
| <code>void CBaseEntity::SetVelocity(Vector)</code>
| 
|-
| <code>CBaseEntity::ValidateScriptScope</code>
| <code>bool CBaseEntity::ValidateScriptScope()</code>
| Ensure that an entity's script scope has been created
|}
=== CEntities ===
==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>CEntities::CreateByClassname</code>
| <code>handle CEntities::CreateByClassname(string)</code>
| Creates an entity by classname
|-
| <code>CEntities::FindByClassname</code>
| <code>handle CEntities::FindByClassname(handle, string)</code>
| Find entities by class name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
|-
| <code>CEntities::FindByClassnameNearest</code>
| <code>handle CEntities::FindByClassnameNearest(string, Vector, float)</code>
| Find entities by class name nearest to a point.
|-
| <code>CEntities::FindByClassnameWithin</code>
| <code>handle CEntities::FindByClassnameWithin(handle, string, Vector, float)</code>
| Find entities by class name within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
|-
| <code>CEntities::FindByModel</code>
| <code>handle CEntities::FindByModel(handle, string)</code>
| Find entities by model name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
|-
| <code>CEntities::FindByName</code>
| <code>handle CEntities::FindByName(handle, string)</code>
| Find entities by name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
|-
| <code>CEntities::FindByNameNearest</code>
| <code>handle CEntities::FindByNameNearest(string, Vector, float)</code>
| Find entities by name nearest to a point.
|-
| <code>CEntities::FindByNameWithin</code>
| <code>handle CEntities::FindByNameWithin(handle, string, Vector, float)</code>
| Find entities by name within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
|-
| <code>CEntities::FindByTarget</code>
| <code>handle CEntities::FindByTarget(handle, string)</code>
| Find entities by targetname. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
|-
| <code>CEntities::FindInSphere</code>
| <code>handle CEntities::FindInSphere(handle, Vector, float)</code>
| Find entities within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
|-
| <code>CEntities::First</code>
| <code>handle CEntities::First()</code>
| Begin an iteration over the list of entities
|-
| <code>CEntities::Next</code>
| <code>handle CEntities::Next(handle)</code>
| Continue an iteration over the list of entities, providing reference to a previously found entity
|}

== See also ==
* [[VScript]]
* [[VScript Fundamentals]]
* {{sq}} [[Squirrel]]