View source for List of Portal 2 Script Functions

{{lang|List of Portal 2 Script Functions|title=List of ''Portal 2'' Script Functions}}
{{p2 topicon}}{{SQ topicon}}
{{toc-right}}

This list contains all engine-related Squirrel functions available for [[VScript]] in {{Portal2|4}}. It can be printed in-game with the <code>script_help</code> command while running in [[Engine tools|tools mode]].

== Variables ==
{| class="standard-table"
!Instance
!Type
!Description
|-
|<code>Entities</code>
|<code>[[#CEntities|CEntities]]</code>
|Provides access to spawned entities in the server.
|-
|}


== Constants ==
{| class="standard-table"
!Instance
!Type
!Value
|-
|<code>_charsize_</code>
|integer
| 1
|-
|<code>_floatsize_</code>
|integer
| 4
|-
|<code>_intsize_</code>
|integer
| 4
|-
|<code>_version_</code>
|string
| "Squirrel 2.2.3 stable"
|-
|<code>RAND_MAX</code>
|integer
| 32767
|-
|<code>PI</code>
|float
| 3.14159
|}


== Classes ==


=== CBaseEntity ===
This is a script handle class for entities. All entities spawned have a script handle using this or one of its subclasses. 

All script handles in-game are accessible from [[#CEntities|Entities]]. Entity scripts can use <code>self</code> to access their own script handle. <code>activator</code> and <code>caller</code> variables can be accessed on function calls.


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>__KeyValueFromInt</code>
| <code>void __KeyValueFromInt(string ''key'', int ''value'')</code>
| Sets an entity [[Keyvalue]] from an integer. This simply changes the value without executing any code that may be needed for the entity to process the KeyValue, so there may be unintended side effects.
|-
| <code>__KeyValueFromFloat</code>
| <code>void __KeyValueFromFloat(string ''key'', float ''value'')</code>
| Sets an entity Keyvalue from a float. This simply changes the value without executing any code that may be needed for the entity to process the KeyValue, so there may be unintended side effects.
|-
| <code>__KeyValueFromString</code>
| <code>void __KeyValueFromString(string ''key'', string ''value'')</code>
| Sets an entity Keyvalue from a string. This simply changes the value without executing any code that may be needed for the entity to process the KeyValue, so there may be unintended side effects.
|-
| <code>__KeyValueFromVector</code>
| <code>void __KeyValueFromVector(string ''key'', Vector ''value'')</code>
| Sets an entity Keyvalue from a [[#Vector|Vector]]. This simply changes the value without executing any code that may be needed for the entity to process the KeyValue, so there may be unintended side effects.
|-
| <code>ConnectOutput</code>
| <code>void CBaseEntity::ConnectOutput(string output, string func_name)</code>
| Adds an I/O connection that will call the named function when the specified output fires. 
|-
| <code>Destroy</code>
| <code>void CBaseEntity::Destroy()</code>
| Kill this entity.
|-
| <code>DisconnectOutput</code>
| <code>void CBaseEntity::DisconnectOutput(string output, string func_name)</code>
| Removes a connected script function from an I/O event.
|-
| <code>EmitSound</code>
| <code>void CBaseEntity::EmitSound(string sound)</code>
| Plays a sound from this entity.
|-
| <code>EyePosition</code>
| <code>Vector CBaseEntity::EyePosition()</code>
| Get vector to eye position - absolute coords
|-
| <code>FirstMoveChild</code>
| <code>handle CBaseEntity::FirstMoveChild()</code>
| If in hierarchy, get the first move child.
|-
| <code>GetAngles</code>
| <code>Vector CBaseEntity::GetAngles()</code>
| Get entity pitch, yaw, roll as a vector
|-
| <code>GetAngularVelocity</code>
| <code>Vector CBaseEntity::GetAngularVelocity()</code>
| Get the local angular velocity - returns a vector of pitch,yaw,roll
|-
| <code>GetBoundingMaxs</code>
| <code>Vector CBaseEntity::GetBoundingMaxs()</code>
| Get a vector containing max bounds, centered on object
|-
| <code>GetBoundingMins</code>
| <code>Vector CBaseEntity::GetBoundingMins()</code>
| Get a vector containing min bounds, centered on object
|-
| <code>GetCenter</code>
| <code>Vector CBaseEntity::GetCenter()</code>
| Get vector to center of object - absolute coords
|-
| <code>GetClassname</code>
| <code>string CBaseEntity::GetClassname()</code>
| Get the classname of this entity.
|-
| <code>GetForwardVector</code>
| <code>Vector CBaseEntity::GetForwardVector()</code>
| Get the forward vector of the entity
|-
| <code>GetHealth</code>
| <code>int CBaseEntity::GetHealth()</code>
| Returns the current [[health]].
|-
| <code>GetLeftVector</code>
| <code>Vector CBaseEntity::GetLeftVector()</code>
| Get the left vector of the entity.
|-
| <code>GetMaxHealth</code>
| <code>int CBaseEntity::GetMaxHealth()</code>
| Returns the maximum health.
|-
| <code>GetModelKeyValues</code>
| <code>handle CBaseEntity::GetModelKeyValues()</code>
| Get a KeyValue class instance on this entity's model.
|-
| <code>GetModelName</code>
| <code>string CBaseEntity::GetModelName()</code>
| Returns the name of the model.
|-
| <code>GetMoveParent</code>
| <code>handle CBaseEntity::GetMoveParent()</code>
| If in hierarchy, retrieves the entity's parent
|-
| <code>GetName</code>
| <code>string CBaseEntity::GetName()</code>
| Get the Targetname of this entity.
|-
| <code>GetOrigin</code>
| <code>Vector CBaseEntity::GetOrigin()</code>
| Returns this entity's local origin.
|-
| <code>GetOwner</code>
| <code>handle CBaseEntity::GetOwner()</code>
| Gets this entity's owner
|-
| <code>GetPreTemplateName</code>
| <code>string CBaseEntity::GetPreTemplateName()</code>
| Get the entity name stripped of template unique decoration
|-
| <code>GetRootMoveParent</code>
| <code>handle CBaseEntity::GetRootMoveParent()</code>
| If in hierarchy, walks up the hierarchy to find the root parent
|-
| <code>GetScriptId</code>
| <code>string CBaseEntity::GetScriptId()</code>
| Retrieve the unique identifier used to refer to the entity within the scripting system.
|-
| <code>GetScriptScope</code>
| <code>handle CBaseEntity::GetScriptScope()</code>
| Retrieve the script-side data associated with an entity.
|-
| <code>GetSoundDuration</code>
| <code>float CBaseEntity::GetSoundDuration(string, string)</code>
| Returns float duration of the sound. Takes soundname and optional actormodelname.
|-
| <code>GetTeam</code>
| <code>int CBaseEntity::GetTeam()</code>
| Get the team this entity is on.
|-
| <code>GetUpVector</code>
| <code>Vector CBaseEntity::GetUpVector()</code>
| Get the up vector of the entity.
|-
| <code>GetVelocity</code>
| <code>Vector CBaseEntity::GetVelocity()</code>
| Get the velocity of the entity.
|-
| <code>IsValid</code>
| <code>bool CBaseEntity::IsValid()</code>
| Returns true if this entity is valid.
|-
| <code>NextMovePeer</code>
| <code>handle CBaseEntity::NextMovePeer()</code>
| Return the next entity in the same movement hierarchy.
|-
| <code>PrecacheSoundScript</code>
| <code>void CBaseEntity::PrecacheSoundScript(string)</code>
| Precache a sound for later playing. Should be called in the 'Precache()' hook function.
|-
| <code>SetAbsOrigin</code>
| <code>void CBaseEntity::SetAbsOrigin(Vector)</code>
| Teleport the entity to this world position.
|-
| <code>SetAngles</code>
| <code>void CBaseEntity::SetAngles(float, float, float)</code>
| Set entity pitch, yaw, roll
|-
| <code>SetAngularVelocity</code>
| <code>void CBaseEntity::SetAngularVelocity(float, float, float)</code>
| Set the local angular velocity - takes float pitch,yaw,roll velocities
|-
| <code>SetForwardVector</code>
| <code>void CBaseEntity::SetForwardVector(Vector)</code>
| Set the orientation of the entity to have this forward vector
|-
| <code>SetHealth</code>
| <code>void CBaseEntity::SetHealth(int)</code>
| Sets the current [[health]].
|-
| <code>SetMaxHealth</code>
| <code>void CBaseEntity::SetMaxHealth(int)</code>
| Sets the maximum health.
|-
| <code>SetModel</code>
| <code>void CBaseEntity::SetModel(string)</code>
| Change the model used for the entity. This can be used to change models for prop_weighted_cube or other similar entities. The model must precached, which is usually done by placing it elsewhere in the map.
|-
| <code>SetOrigin</code>
| <code>void CBaseEntity::SetOrigin(Vector)</code>
| Teleport this entity to the given location.
|-
| <code>SetOwner</code>
| <code>void CBaseEntity::SetOwner(handle)</code>
| Sets this entity's owner
|-
| <code>SetSize</code>
| <code>void CBaseEntity::SetSize(Vector, Vector)</code>
| Sets the bounding box size.
|-
| <code>SetTeam</code>
| <code>void CBaseEntity::SetTeam(int)</code>
| Set the team this entity is on.
|-
| <code>SetVelocity</code>
| <code>void CBaseEntity::SetVelocity(Vector)</code>
| Set local velocity.
|-
| <code>ValidateScriptScope</code>
| <code>bool CBaseEntity::ValidateScriptScope()</code>
| Ensure that an entity's script scope has been created. This should be called before assigning to the entity's scope.
|-
| <code>entindex</code>
| <code>int CBaseEntity::entindex()</code>
| Returns the entity index.
|}


=== CBaseAnimating ===
Extends [[#CBaseEntity|CBaseEntity]]

Script handle class for animating entities such as props.


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>GetAttachmentAngles</code>
| <code>Vector CBaseAnimating::GetAttachmentAngles(int id)</code>
| Get the attachment id's angles as a p,y,r vector.
|-
| <code>GetAttachmentOrigin</code>
| <code>Vector CBaseAnimating::GetAttachmentOrigin(int id)</code>
| Get the attachment id's origin vector
|-
| <code>GetObjectScaleLevel</code>
| <code>int CBaseAnimating::GetObjectScaleLevel()</code>
| The scale size of the entity
|-
| <code>IsSequenceFinished</code>
| <code>bool CBaseAnimating::IsSequenceFinished()</code>
| Ask whether the main sequence is done playing
|-
| <code>LookupAttachment</code>
| <code>int CBaseAnimating::LookupAttachment(string)</code>
| Get the ID for the named attachment.
|-
| <code>SetBodygroup</code>
| <code>void CBaseAnimating::SetBodygroup(int group, int index)</code>
| Sets a bodygroup. Group is the index for the desired group, and index is the desired part to use.
|}


=== CBaseFlex ===
Extends [[#CBaseAnimating|CBaseAnimating]]


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>GetCurrentScene</code>
| <code>handle CBaseFlex::GetCurrentScene()</code>
| Returns the instance of the oldest active scene entity (if any).
|-
| <code>GetSceneByIndex</code>
| <code>handle CBaseFlex::GetSceneByIndex(int)</code>
| Returns the instance of the scene entity at the specified index.
|}


=== CBasePlayer ===
Extends [[#CBaseAnimating|CBaseAnimating]]


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>IsNoclipping</code>
| <code>bool CBasePlayer::IsNoclipping()</code>
| Returns true if the player is in noclip mode.
|}


=== CEntities ===
Script instance: <code>Entities</code>

An interface to find and iterate over the script handles for the entities in play. 

To iterate over a set of entities, pass <code>null</code> to the ''previous'' argument in the appropriate method to start an iteration, or reference to a previously found entity to continue a search. Example:
<source lang=cpp>
//The first way
local ent = null;     //The variable name "ent" is arbitrary.
while(ent = Entities.FindByName(ent, "entityname"))     //Indeed, we mean '=' and not '==' ! The loop aborts if "ent" becomes null.
{
  //...     //In every iteration, "ent" is not null.
}

//The second way
for(local ent;ent = Entities.FindByName(ent, "entityname");)     //The variable name "ent" is arbitrary. Indeed, we mean '=' and not '==' ! The loop aborts if "ent" becomes null. (All the semicolons are correctly placed)
{
  //...     //In every iteration, "ent" is not null.
}
</source>


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>CreateByClassname</code>
| <code>handle CEntities::CreateByClassname(string)</code>
| Creates an entity by classname
|-
| <code>FindByClassname</code>
| <code>handle CEntities::FindByClassname(handle start_ent, string classname)</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 classname, Vector loc, float radius)</code>
| Find entities by class name nearest to a point.
|-
| <code>FindByClassnameWithin</code>
| <code>handle CEntities::FindByClassnameWithin(handle start_ent, string classname, Vector loc, float radius)</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 start_ent, string model)</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 start_ent, string targetname)</code>
| Find entities by name (including wildcards). 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 targetname, Vector loc, float radius)</code>
| Find entities by name nearest to a point.
|-
| <code>FindByNameWithin</code>
| <code>handle CEntities::FindByNameWithin(handle, string, Vector loc, float radius)</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>FindByTarget</code>
| <code>handle CEntities::FindByTarget(handle start_ent, string targetname)</code>
| Find entities with a specific <code>target</code> keyvalue. 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 start_ent, Vector loc, float radius)</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. Equivalent to Next(null).
|-
| <code>Next</code>
| <code>handle CEntities::Next(handle)</code>
| Continue an iteration over the list of entities, providing reference to a previously found entity.
|}


=== CEnvEntityMaker ===
Extends [[#CBaseEntity|CBaseEntity]]

Script handle class for [[env_entity_maker]]. 


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>SpawnEntity</code>
| <code>void CEnvEntityMaker::SpawnEntity()</code>
| Create an entity at the location of the maker
|-
| <code>SpawnEntityAtEntityOrigin</code>
| <code>void CEnvEntityMaker::SpawnEntityAtEntityOrigin(handle)</code>
| Create an entity at the location of a specified entity instance
|-
| <code>SpawnEntityAtLocation</code>
| <code>void CEnvEntityMaker::SpawnEntityAtLocation(Vector, Vector)</code>
| Create an entity at a specified location and orientaton, orientation is Euler angle in degrees (pitch, yaw, roll)
|-
| <code>SpawnEntityAtNamedEntityOrigin</code>
| <code>void CEnvEntityMaker::SpawnEntityAtNamedEntityOrigin(string)</code>
| Create an entity at the location of a named entity
|}


=== CLinkedPortalDoor ===
{{todo}}


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>GetPartnerInstance</code>
| <code>handle CLinkedPortalDoor::GetPartnerInstance()</code>
| Get the instance handle of the door's linked partner
|-
| <code>GetPartnername</code>
| <code>string CLinkedPortalDoor::GetPartnername()</code>
| Returns the partnername of the door.
|}


=== CPlayerVoiceListener ===
{{todo}}


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>GetPlayerSpeechDuration</code>
| <code>float CPlayerVoiceListener::GetPlayerSpeechDuration(int)</code>
| Returns the number of seconds the player has been continuously speaking.
|-
| <code>IsPlayerSpeaking</code>
| <code>bool CPlayerVoiceListener::IsPlayerSpeaking(int)</code>
| Returns whether the player specified is speaking.
|}


=== CPortal_Player ===
{{todo}}


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>GetWheatleyMonitorDestructionCount</code>
| <code>int CPortal_Player::GetWheatleyMonitorDestructionCount()</code>
| Get number of wheatley monitors destroyed by the player.
|-
| <code>IncWheatleyMonitorDestructionCount</code>
| <code>void CPortal_Player::IncWheatleyMonitorDestructionCount()</code>
| Set number of wheatley monitors destroyed by the player.
|-
| <code>TurnOffPotatos</code>
| <code>void CPortal_Player::TurnOffPotatos()</code>
| Turns Off the Potatos material light
|-
| <code>TurnOnPotatos</code>
| <code>void CPortal_Player::TurnOnPotatos()</code>
| Turns On the Potatos material light
|}


=== CPropLinkedPortalDoor ===
{{todo}}


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>GetPartnerInstance</code>
| <code>handle CPropLinkedPortalDoor::GetPartnerInstance()</code>
| Get the instance handle of the door's linked partner
|-
| <code>GetPartnername</code>
| <code>string CPropLinkedPortalDoor::GetPartnername()</code>
| Returns the partnername of the door.
|}


=== CSceneEntity ===
Extends [[#CBaseEntity|CBaseEntity]]


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>AddBroadcastTeamTarget</code>
| <code>void CSceneEntity::AddBroadcastTeamTarget(int)</code>
| Adds a team (by index) to the broadcast list
|-
| <code>EstimateLength</code>
| <code>float CSceneEntity::EstimateLength()</code>
| Returns length of this scene in seconds.
|-
| <code>FindNamedEntity</code>
| <code>handle CSceneEntity::FindNamedEntity(string)</code>
| given an entity reference, such as !target, get actual entity from scene object
|-
| <code>IsPaused</code>
| <code>bool CSceneEntity::IsPaused()</code>
| If this scene is currently paused.
|-
| <code>IsPlayingBack</code>
| <code>bool CSceneEntity::IsPlayingBack()</code>
| If this scene is currently playing.
|-
| <code>LoadSceneFromString</code>
| <code>bool CSceneEntity::LoadSceneFromString(string, string)</code>
| given a dummy scene name and a vcd string, load the scene
|-
| <code>RemoveBroadcastTeamTarget</code>
| <code>void CSceneEntity::RemoveBroadcastTeamTarget(int)</code>
| Removes a team (by index) from the broadcast list
|}


=== CScriptKeyValues ===
Script handle representation of a models [[$keyvalues]] block.
Sub keys are instances of the same class.


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>FindKey</code>
| <code>handle CScriptKeyValues::FindKey(string)</code>
| Given a KeyValues object and a key name, find a KeyValues object associated with the key name
|-
| <code>GetFirstSubKey</code>
| <code>handle CScriptKeyValues::GetFirstSubKey()</code>
| Given a KeyValues object, return the first sub key object
|-
| <code>GetKeyBool</code>
| <code>bool CScriptKeyValues::GetKeyBool(string)</code>
| Given a KeyValues object and a key name, return associated bool value
|-
| <code>GetKeyFloat</code>
| <code>float CScriptKeyValues::GetKeyFloat(string)</code>
| Given a KeyValues object and a key name, return associated float value
|-
| <code>GetKeyInt</code>
| <code>int CScriptKeyValues::GetKeyInt(string)</code>
| Given a KeyValues object and a key name, return associated integer value
|-
| <code>GetKeyString</code>
| <code>string CScriptKeyValues::GetKeyString(string)</code>
| Given a KeyValues object and a key name, return associated string value
|-
| <code>GetNextKey</code>
| <code>handle CScriptKeyValues::GetNextKey()</code>
| Given a KeyValues object, return the next key object in a sub key group
|-
| <code>IsKeyEmpty</code>
| <code>bool CScriptKeyValues::IsKeyEmpty(string)</code>
| Given a KeyValues object and a key name, return true if key name has no value
|-
| <code>ReleaseKeyValues</code>
| <code>void CScriptKeyValues::ReleaseKeyValues()</code>
| Given a root KeyValues object, release its contents
|}


=== CTriggerCamera ===
Extends [[#CBaseEntity|CBaseEntity]]


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>GetFov</code>
| <code>int CTriggerCamera::GetFov()</code>
| get camera's current fov setting as integer
|-
| <code>SetFov</code>
| <code>void CTriggerCamera::SetFov(int, float)</code>
| set camera's current fov in integer degrees and fov change rate as float
|}


=== Math ===
The built-in [http://www.squirrel-lang.org/mainsite/doc/sqstdlib2.html#d0e1519 Squirrel math library].


{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>abs</code>
| <code> int abs(float ''x'')</code>
| Returns the absolute value of <code>x</code> as an integer.
|-
| <code>acos</code>
| <code> float acos(float ''x'')</code>
| Returns the arccosine of <code>x</code>.
|-
| <code>asin</code>
| <code> float asin(float ''x'')</code>
| Returns the arcsine of <code>x</code>.
|-
| <code>atan</code>
| <code> float atan(float ''x'')</code>
| Returns the arctangent of <code>x</code>.
|-
| <code>atan2</code>
| <code> float atan2(float ''x'', float ''y'')</code>
| Returns the arctangent of <code>x/y</code>.
|-
| <code>ceil</code>
| <code> float ceil(float ''x'')</code>
| Returns a float value representing the smallest integer that is greater than or equal to <code>x</code>.
|-
| <code>cos</code>
| <code> float cos(float ''x'')</code>
| Returns the cosine of <code>x</code>.
|-
| <code>exp</code>
| <code> float exp(float ''x'')</code>
| Returns the exponential value (<code>e^x</code>) of the float parameter <code>x</code>.
|-
| <code>fabs</code>
| <code> float fabs(float ''x'')</code>
| Returns the absolute value of <code>x</code> as a float.
|-
| <code>floor</code>
| <code> float floor(float ''x'')</code>
| Returns a float value representing the largest integer that is less than or equal to <code>x</code>.
|-
| <code>log</code>
| <code> float log(float ''x'')</code>
| Returns the natural logarithm of <code>x</code>.
|-
| <code>log10</code>
| <code> float log10(float ''x'')</code>
| Returns the logarithm base-10 of <code>x</code>.
|-
| <code>pow</code>
| <code> float pow(float ''x'', float ''y'')</code>
| Returns <code>x</code> raised to the power of <code>y</code>.
|-
| <code>rand</code>
| <code> int rand()</code>
| Returns a pseudorandom integer in the range 0 to <code>RAND_MAX</code>.
|-
| <code>sin</code>
| <code> float sin(float ''x'')</code>
| Returns the sine of <code>x</code>.
|-
| <code>sqrt</code>
| <code> float sqrt(float ''x'')</code>
| Returns the square root of <code>x</code>.
|-
| <code>srand</code>
| <code> void srand(float ''seed'')</code>
| Sets the starting point for generating a series of pseudorandom integers.
|-
| <code>tan</code>
| <code> float tan(float ''x'')</code>
| Returns the tangent of <code>x</code>.
|}


=== Vector ===
Represents an x/y/z position, returned/passed to many functions. It takes the 3 x/y/z positions as a parameter.<br>
A few math operations can be applied to vectors - ''+/-'' between any two vectors, and <code>Vector * number</code> in that order only. All three operations return another vector. Other math operations are done with method calls:


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>Cross</code>
| <code>Vector Vector::Cross(Vector other)</code>
| Return the vector cross product - <code>this × other</code>.
|-
| <code>Dot</code>
| <code>float Vector::Dot(Vector other)</code>
| Return the vector dot product - <code>this · other</code>.
|-
| <code>Length</code>
| <code>float Vector::Length()</code>
| Return the distance from the origin.
|-
| <code>Length2D</code>
| <code>float Vector::Length2D()</code>
| Return the distance from the origin, ignoring the Z axis.
|-
| <code>LengthSqr</code>
| <code>float Vector::LengthSqr()</code>
| Return the distance from the origin, but squared. This is faster to compute since a square root isn\'t required.
|-
| <code>Length2DSqr</code>
| <code>float Vector::Length2DSqr()</code>
| Return the distance from the origin, ignoring the Z axis and squared. This is faster to compute since a square root isn\'t required.
|-
| <code>Norm</code>
| <code>float Vector::Norm()</code>
| Modify the vector to have a length of 1, and return its original length.
|-
| <code>ToKVString</code>
| <code>string Vector::ToKVString()</code>
| Return a string in the form "X Y Z".
|}


=== Other ===
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>Assert</code>
| <code>void Assert(''exp'', string ''message'' = null)</code>
| Throws an exception if ''exp'' equates to false, optionally with message.
|-
| <code>AddBranchLevelName</code>
| <code>void AddBranchLevelName(int, string)</code>
| Adds a level to the specified branch's list.
|-
| <code>AddCoopCreditsName</code>
| <code>void AddCoopCreditsName(string)</code>
| Adds a name to the coop credit's list.
|-
| <code>CreateProp</code>
| <code>handle CreateProp(string classname, Vector origin, string modelname, int activity)</code>
| Create a prop. The class should be a prop_physics style entity.
|-
| <code>CreateSceneEntity</code>
| <code>handle CreateSceneEntity(string)</code>
| Create a scene entity to play the specified scene.
|-
| <code>DebugDrawBox</code>
| <code>void DebugDrawBox(Vector origin, Vector mins, Vector maxs, int r, int g, int b, int alpha, float duration)</code>
| Draw a debug box, for visualizing code. It's positioned at <code>origin</code>, with the dimensions <code>mins</code>/<code>maxs</code> Developer must be on to show this, and it'll stay around for <code>duration</code> seconds (or 1 frame if -1.0). The color ranges from 0-255.
|-
| <code>DebugDrawLine</code>
| <code>void DebugDrawLine(Vector start, Vector end, int r, int g, int b, bool hitTest, float duration)</code>
| Draw a debug line, for visualizing code. Developer must be on to show this, and it'll stay around for <code>duration</code> seconds (or 1 frame if -1.0). The color ranges from 0-255.
|-
| <code>DoIncludeScript</code>
| <code>bool DoIncludeScript(string ''filename'', table ''scope'')</code>
| Execute the script file <code>"scripts/vscripts/" + filename</code> in the scope of <code>scope</code>. The extension <code>.nut</code> can be omitted.
|-
| <code>IncludeScript</code>
| <code>bool IncludeScript(string ''filename'', table ''scope'' = null)</code>
| Execute the script file <code>"scripts/vscripts/" + filename</code> in the scope of <code>scope</code>, <code>this</code> by default. The extension <code>.nut</code> can be omitted.
|-
| <code>DoEntFire</code>
| <code>void DoEntFire(string ''target'', string ''action'', string ''value'', float ''delay'', handle ''activator'', handle ''caller'')</code>
| Generate an entity [[I/O]] event.
|-
| <code>EntFire</code>
| <code>function EntFire(target, action, value, delay, activator)</code>
| Generate an entity [[I/O]] event. Value, delay and activator are optional.
|-
| <code>EntFireByHandle</code>
| <code>void EntFireByHandle(handle target, string action, string value, float delay, handle activator, handle caller)</code>
| Generate an entity I/O event. First parameter is an entity instance.
|-
| <code>FrameTime</code>
| <code>float FrameTime()</code>
| Get the time spent on the server in the last frame.
|-
| <code>GetBluePlayerIndex</code>
| <code>int GetBluePlayerIndex()</code>
| Player index of the blue player.
|-
| <code>GetCoopBranchLevelIndex</code>
| <code>int GetCoopBranchLevelIndex(int)</code>
| Given the 'branch' argument, returns the current chosen level.
|-
| <code>GetCoopSectionIndex</code>
| <code>int GetCoopSectionIndex()</code>
| Section that the coop players have selected to load.
|-
| <code>GetDeveloperLevel</code>
| <code>int GetDeveloperLevel()</code>
| Gets the level of 'developer'.
|-
| <code>GetHighestActiveBranch</code>
| <code>int GetHighestActiveBranch()</code>
| Returns which branches should be available in the hub.
|-
| <code>GetMapName</code>
| <code>string GetMapName()</code>
| Get the name of the map.
|-
| <code>GetOrangePlayerIndex</code>
| <code>int GetOrangePlayerIndex()</code>
| Player index of the orange player.
|-
| <code>GetPlayer</code>
| <code>handle GetPlayer()</code>
| Returns the player (SP Only).
|-
| <code>GetPlayerSilenceDuration</code>
| <code>float GetPlayerSilenceDuration(int player_index)</code>
| Time that the specified player has been silent on the mic.
|-
| <code>IsLevelComplete</code>
| <code>bool IsLevelComplete(int course, int level)</code>
| Returns true if the level in the specified course is completed by either player.
|-
| <code>IsMultiplayer</code>
| <code>bool IsMultiplayer()</code>
| Is this a multiplayer game?
|-
| <code>IsPlayerLevelComplete</code>
| <code>bool IsPlayerLevelComplete(int, int, int)</code>
| Returns true if the level in the specified branch is completed by a specific player.
|-
| <code>LoopSinglePlayerMaps</code>
| <code>bool LoopSinglePlayerMaps()</code>
| Run the single player maps in a continuous loop.
|-
| <code>MarkMapComplete</code>
| <code>void MarkMapComplete(string)</code>
| Marks a maps a complete for both players.
|-
| <code>PrecacheMovie</code>
| <code>void PrecacheMovie(string)</code>
| Precaches a named movie. Only valid to call within the entity's 'Precache' function called on mapspawn.
|-
| <code>RandomFloat</code>
| <code>float RandomFloat(float min, float max)</code>
| Generate a random floating point number within a range, inclusive
|-
| <code>RandomInt</code>
| <code>int RandomInt(int min, int max)</code>
| Generate a random integer within a range, inclusive
|-
| <code>RecordAchievementEvent</code>
| <code>void RecordAchievementEvent(string name, int player_index)</code>
| "Earns" a given achievement or increases progress.
|-
| <code>RetrieveNativeSignature</code>
| <code>void RetrieveNativeSignature(string ''nativeFunction'')</code>
| {{todo}}
|-
| <code>ScriptShowHudMessageAll</code>
| <code>void ScriptShowHudMessageAll(string, float)</code>
| Show center print text message.
|-
| <code>ScriptSteamShowURL</code>
| <code>bool ScriptSteamShowURL(string)</code>
| Bring up the steam overlay and shows the specified URL.  (Full address with protocol type is required, e.g. http://www.steamgames.com/)
|-
| <code>SendToConsole</code>
| <code>void SendToConsole(string command)</code>
| Send a string to the console as a command.
|-
| <code>SetDucking</code>
| <code>void SetDucking(string, string, float)</code>
| Set the level of an audio ducking channel
|-
| <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>TraceLine</code>
| <code>float TraceLine(Vector start, Vector end, handle ignored_ent)</code>
| Given 2 points and an entity to ignore, return fraction along line that hits world or models.{{bug| Ignores all entities, hits only the world}}
|-
| <code>UniqueString</code>
| <code>string UniqueString(string ''suffix'' = "")</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. Equivalent to <code>DoUniqueString(suffix)</code>.
|-
| <code>DoUniqueString</code>
| <code>string DoUniqueString(string ''suffix'')</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.
|-
| <code>__ReplaceClosures</code>
| <code>void __ReplaceClosures(function ''script'', table ''scope'')</code>
| Internal function called in <code>script_reload_</code> server commands.
|}

=== Introduced in "Peer Review" ===
These were introduced in Portal 2's first DLC, "Peer Review", to prevent cheating in challenge mode.
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>TryDLC1InstalledOrCatch</code>
| <code>void TryDLC1InstalledOrCatch()</code>
| Throws an exception if "Peer Review" isn't installed.
|-
| <code>GivePlayerPortalgun</code>
| <code>void GivePlayerPortalgun()</code>
| Equips the player with a blue-only portalgun.
|-
| <code>UpgradePlayerPortalgun</code>
| <code>void UpgradePlayerPortalgun()</code>
| Upgrades the player's portalgun to shoot orange portals.
|-
| <code>UpgradePlayerPotatogun</code>
| <code>void UpgradePlayerPotatogun()</code>
| Upgrades the player's portalgun to shoot orange portals and have PotatOS impaled on it.
|}


== See also ==
* [[VScript]]
* [[VScript Fundamentals]]
* {{sq}} [[Squirrel]]
* {{l4d2}} [[List of L4D2 Script Functions]]
* {{csgo}} [[List of Counter-Strike: Global Offensive Script Functions]]

[[Category:Portal 2]]
[[Category:Scripting]]