View source for List of ND Script Functions

{{sq}} This list contains all engine-related Squirrel variables, functions, and constants currently available for [[VScript]] in {{game link|Nuclear Dawn}}. Some are not available yet but guaranteed to be in the next update. More not yet listed are also being added to the game and not yet listed.

== Variables ==

== Classes ==
=== CEntities ===
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>CreateByClassname</code>
| <code>handle CEntities::CreateByClassname(string)</code>
| Creates entity by class name.
|-
| <code>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>FindByClassnameNearest</code>
| <code>handle CEntities::FindByClassnameNearest(string, Vector, float)</code>
| Find entities by class name nearest to a point.
|-
| <code>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>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>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>FindByNameNearest</code>
| <code>handle CEntities::FindByNameNearest(string, Vector, float)</code>
| Find entities by name nearest to a point.
|-
| <code>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 continue a search
|-
| <code>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>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>First</code>
| <code>handle CEntities::First()</code>
| Begin an iteration over the list of entities
|-
| <code>Next</code>
| <code>handle CEntities::Next(handle)</code>
| Continue an iteration over the list of entities, providing reference to a previously found entity
|}

=== CBaseEntity ===
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>ConnectOutput</code>
| <code>void ConnectOutput(string, string)</code>
| Adds an I/O connection that will call the named function when the specified output fires
|-
| <code>DisconnectOutput</code>
| <code>void DisconnectOutput(string, string)</code>
| Removes a connected script function from an I/O event.
|-
| <code>GetHealth</code>
| <code>int GetHealth()</code>
| Returns health of the entity.
|-
| <code>SetHealth</code>
| <code>void SetHealth(int)</code>
| Sets health of the entity.
|-
| <code>GetMaxHealth</code>
| <code>int GetMaxHealth()</code>
| Returns maximum health amount of the entity.
|-
| <code>GetTeam</code>
| <code>handle GetTeam()</code>
| Returns handle to the entity's team.
|-
| <code>GetTeamNumber</code>
| <code>int GetTeamNumber()</code>
| Returns team index of the entity (0 - Unassigned, 1 - Spectator, 2 - Consortium, 3 - Empire).
|-
| <code>GetLifeState</code>
| <code>int GetLifeState()</code>
| Returns life state of the entity (0 - alive, 1 - dying, 2 - dead).
|-
| <code>GetClassname</code>
| <code>string GetClassname()</code>
| Returns classname of the entity.
|-
| <code>GetName</code>
| <code>string GetName()</code>
| Returns target name of the entity.
|-
| <code>GetPreTemplateName</code>
| <code>string GetPreTemplateName()</code>
| Get the entity name stripped of template unique decoration.
|-
| <code>GetOrigin</code>
| <code>vector GetOrigin()</code>
| Returns absolute origin of the entity.
|-
| <code>SetOrigin</code>
| <code>void SetOrigin(vector)</code>
| Sets absolute origin of the entity.
|-
| <code>GetForwardVector</code>
| <code>vector GetForwardVector()</code>
| Get the forward vector of the entity.
|-
| <code>SetForwardVector</code>
| <code>void SetForwardVector(vector)</code>
| Set the orientation of the entity to have this forward vector.
|-
| <code>GetVelocity</code>
| <code>vector GetVelocity()</code>
| Get the velocity of the entity.
|-
| <code>SetVelocity</code>
| <code>void SetVelocity(vector)</code>
| Set the velocity of the entity.
|-
| <code>GetMoveParent</code>
| <code>handle GetMoveParent()</code>
| Get handle to the move parent of the entity.
|-
| <code>GetRootMoveParent</code>
| <code>handle GetRootMoveParent()</code>
| Get handle to the root move parent of the entity.
|-
| <code>FirstMoveChild</code>
| <code>handle FirstMoveChild()</code>
| Get handle to the first move child of the entity.
|-
| <code>NextMovePeer</code>
| <code>handle NextMovePeer()</code>
| Get handle to the next move peer of the entity.
|-
| <code>__KeyValueFromString</code>
| <code>void __KeyValueFromString(string, string)</code>
| Sets string value for key name on the entity.
|-
| <code>__KeyValueFromInt</code>
| <code>void __KeyValueFromInt(string, int)</code>
| Sets int value for key name on the entity.
|-
| <code>__KeyValueFromVector</code>
| <code>void __KeyValueFromVector(string, vector)</code>
| Sets vector value for key name on the entity.
|-
| <code>ValidateScriptScope</code>
| <code>bool ValidateScriptScope()</code>
| Ensure that an entity's script scope has been created.
|-
| <code>GetScriptScope</code>
| <code>handle GetScriptScope()</code>
| Retrieve the script-side data associated with an entity.
|-
| <code>GetScriptId</code>
| <code>int GetScriptId()</code>
| Retrieve the unique identifier used to refer to the entity within the scripting system.
|}

=== CNDPlayer ===
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>IsCommander</code>
| <code>bool IsCommander()</code>
| Get whether or not the player is the commander for their team.
|-
| <code>IsCommanding</code>
| <code>bool IsCommanding()</code>
| Get whether or not the player is currently in RTS mode.
|-
| <code>GetSquad</code>
| <code>handle GetSquad()</code>
| Returns handle to the player's squad.
|-
| <code>GetSquadNumber</code>
| <code>int GetSquadNumber()</code>
| Returns squad index of the player (0 - Alpha, 1 - Bravo, 2 - Charlie, 3 - Delta).
|-
| <code>GetClass</code>
| <code>int GetClass()</code>
| Returns class index of the player.
|-
| <code>GetKit</code>
| <code>int GetKit()</code>
| Returns kit index of the player.
|-
| <code>GetActiveGizmo</code>
| <code>int GetActiveGizmo()</code>
| Returns index of the player's currently selected gizmo.
|-
| <code>IsGizmoActive</code>
| <code>bool IsGizmoActive(int)</code>
| Returns whether effect of gizmo is active, either from equipped on player or active gizmo for player's squad.
|-
| <code>IsInCondition</code>
| <code>bool IsInCondition(int)</code>
| Returns whether given condition is currently applied to the player.
|-
| <code>GetWeaponByName</code>
| <code>handle GetWeaponByName(string)</code>
| Returns handle to weapon owned by player of specified classname or null if unowned.
|-
| <code>GetAmmoCount</code>
| <code>int GetAmmoCount(int)</code>
| Returns reserve ammo count of the player of specificed ammo type.
|-
| <code>GiveAmmo</code>
| <code>void GiveAmmo(int, int)</code>
| Gives the player ammo of specified type.
|}

=== CNDTeam ===
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>GetTeamName</code>
| <code>string GetTeamName()</code>
| Returns name of the team.
|-
| <code>GetResources</code>
| <code>int GetResources()</code>
| Returns resource count of the team.
|-
| <code>SetResources</code>
| <code>void SetResources(int)</code>
| Sets resource count of the team.
|-
| <code>GetCommander</code>
| <code>handle GetCommander()</code>
| Returns handle to team's commander player.
|-
| <code>GetSquad</code>
| <code>handle GetSquad(int)</code>
| Returns handle to indexed squad for the team.
|-
| <code>GetPlayerCount</code>
| <code>int GetPlayerCount()</code>
| Returns the number of players in the team.
|-
| <code>GetPlayer</code>
| <code>handle GetPlayer(int)</code>
| Returns handle to player at specified index of team players (0-based).
|}

=== CNDSquad ===
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>GetActiveGizmo</code>
| <code>int GetActiveGizmo</code>
| Returns the active gizmo for the squad.
|-
| <code>AddPlayer</code>
| <code>void AddPlayer(handle)</code>
| Adds player to the squad.
|-
| <code>RemovePlayer</code>
| <code>void RemovePlayer(handle)</code>
| Removes player from the squad.
|-
| <code>HasPlayer</code>
| <code>bool HasPlayer(handle)</code>
| Returns whether or not the player is in the squad.
|}

=== CNDBaseWeapon ===
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>GetClipAmmoCount</code>
| <code>int GetClipAmmoCount()</code>
| Returns the current ammo count inside the clip of the weapon.
|-
| <code>SetClipAmmoCount</code>
| <code>void SetClipAmmoCount(int)</code>
| Sets the current ammo count inside the clip of the weapon.
|-
| <code>GetAmmoType</code>
| <code>int GetAmmoType()</code>
| Returns the ammo type used by the weapon.
|-
| <code>GetMaxClipAmmoCount</code>
| <code>int GetMaxClipAmmoCount()</code>
| Returns the maximum amount of ammo that the clip of the weapon can hold.
|-
| <code>GetDefaultClipAmmoCount</code>
| <code>int GetDefaultClipAmmoCount()</code>
| Returns the default amount of ammo that the clip of the weapon holds.
|}

=== CEnvEntityMaker ===

=== CCallChainer ===

=== CSimpleCallChainer ===

=== regxp ===

=== Vector ===

== Other functions ==
=== Engine specific ===
{| 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>EntFire</code>
| <code>function EntFire(target, action, value, delay, activator)</code>
| Generate and entity i/o event
|-
| <code>GetTeam</code>
| <code>function GetTeam( int )</code>
| Returns handle to a team by index. (0 - Unassigned, 1 - Spectators, 2 - Consortium, 3 - Empire)
|-
| <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>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
|-
| <code>UniqueString</code>
| <code>function UniqueString(string)</code>
| Generate a string guaranteed to be unique across the life of the script VM, with an optional root string. Useful for adding data to tables when not sure what keys are already in use in that table.
|}

=== Standard Squirrel libary ===

== Constants ==

== See also ==
* [[L4D2 Vscripts]]
* [[L4D2 Vscript Examples]]
* {{portal2}} [[List of Portal 2 Script Functions]]

[[Category:Nuclear Dawn]]
[[Category:Scripting]]