Dumped global this. Complete documentation.
| Symbol | Value |
|---|---|
| _version_ | Squirrel 2.2.3 stable |
| Symbol | Value |
|---|---|
| _charsize_ | 1 |
| _floatsize_ | 4 |
| _intsize_ | 4 |
| RAND_MAX | 32767 |
| Symbol | Value |
|---|---|
| PI | 3.14159 |
| Symbol | Value |
|---|---|
| Entities | |
| player | ([1] player) |
| PlayerVoiceListener |
| Symbol |
|---|
| Documentation |
| Symbol | Description |
|---|---|
| __dump__ | |
| __DumpScope | |
| __ReplaceClosures | |
| Assert | |
| AwardAchievement | |
| Document | |
| EntFire | Generate and entity i/o event |
| IncludeScript | |
| Msg | |
| PrintHelp | |
| printl | |
| RegisterFunctionDocumentation | |
| RetrieveNativeSignature | |
| UniqueString | 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. |
| VSquirrel_OnCreateScope | |
| VSquirrel_OnReleaseScope |
| Signature | Returns | Description |
|---|---|---|
| AddBranchLevelName(int, string) | void | Adds a level to the specified branche’s list. |
| AddCoopCreditsName(string) | void | Adds a name to the coop credit’s list. |
| CreateProp(string, Vector, string, int) | handle | Create a physics prop |
| CreateSceneEntity(string) | handle | Create a scene entity to play the specified scene. |
| DebugDrawBox(Vector, Vector, Vector, int, int, int, int, float) | void | Draw a debug overlay box |
| DebugDrawLine(Vector, Vector, int, int, int, bool, float) | void | Draw a debug overlay box |
| DoIncludeScript(string, handle) | bool | Execute a script (internal) |
| EntFireByHandle(handle, string, string, float, handle, handle) | void | Generate and entity i/o event. First parameter is an entity instance. |
| FrameTime() | float | Get the time spent on the server in the last frame |
| GetBluePlayerIndex() | int | Player index of the blue player. |
| GetCoopBranchLevelIndex(int) | int | Given the ‘branch’ argument, returns the current chosen level. |
| GetCoopSectionIndex() | int | Section that the coop players have selected to load. |
| GetDeveloperLevel() | int | Gets the level of ‘develoer’ |
| GetGlobalCounter(string) | int | Gets the specific global counter count. |
| GetGlobalState(string) | int | Gets the specific global state. Returns 0 for off, 1 for on, 2 for dead. |
| GetHighestActiveBranch() | int | Returns which branches should be available in the hub. |
| GetMapIndexInPlayOrder() | int | Determines which index (by order played) this map is. Returns -1 if entry is not found. -2 if this is not a known community map. |
| GetMapName() | string | Get the name of the map. |
| GetNumMapsPlayed() | int | Returns how many maps the player has played through. |
| GetOrangePlayerIndex() | int | Player index of the orange player. |
| GetPlayer() | handle | Returns the player (SP Only). |
| GetPlayerSilenceDuration(int) | float | Time that the specified player has been silent on the mic. |
| GetSaveVersion() | string | Returns the version string of the currently loaded save. Returns an empty string for transitions and new games. |
| GivePlayerPortalgun() | void | Give player the portalgun. |
| IsInGlobalTable(string) | bool | Gets if we have global state for this at all, regardless of if its on or off. |
| IsLevelComplete(int, int) | bool | Returns true if the level in the specified branch is completed by either player. |
| IsMultiplayer() | bool | Is this a multiplayer game? |
| IsPlayerLevelComplete(int, int, int) | bool | Returns true if the level in the specified branch is completed by a specific player. |
| LoopSinglePlayerMaps() | bool | Run the single player maps in a continuous loop. |
| MarkMapComplete(string) | void | Marks a maps a complete for both players. |
| PrecacheMovie(string) | void | Precaches a named movie. Only valid to call within the entity’s ‘Precache’ function called on mapspawn. |
| RandomFloat(float, float) | float | Generate a random floating point number within a range, inclusive |
| RandomInt(int, int) | int | Generate a random integer within a range, inclusive |
| RecordAchievementEvent(string, int) | void | Records achievement event or progress |
| RequestMapRating() | void | Pops up the map rating dialog for user input |
| ScriptShowHudMessageAll(string, float) | void | Show center print text message. |
| ScriptSteamShowURL(string) | bool | Bring up the steam overlay and shows the specified URL. (Full address with protocol type is required, e.g. http://www.steamgames.com/) |
| SendToConsole(string) | void | Send a string to the console as a command |
| SetDucking(string, string, float) | void | Set the level of an audio ducking channel |
| SetMapAsPlayed() | int | Adds the current map to the play order and returns the new index therein. Returns -2 if this is not a known community map. |
| ShowMessage(string) | void | Print a hud message on all clients |
| Time() | float | Get the current server time |
| TraceLine(Vector, Vector, handle) | float | given 2 points & ent to ignore, return fraction along line that hits world or models |
| TryDLC1InstalledOrCatch() | bool | Tests if the DLC1 is installed for Try/Catch blocks. |
| UpgradePlayerPortalgun() | void | Give player the portalgun. |
| UpgradePlayerPotatogun() | void | Give player the portalgun. |
| WasLoadGame() | bool | Returns true if we just loaded a saved game. |
| WasNewGame() | bool | Returns true if we just started a new game from this map. |
| WasTransition() | bool | Returns true if we just transitioned here from another map. |
| Symbol |
|---|
| abs |
| acos |
| asin |
| atan |
| atan2 |
| ceil |
| cos |
| exp |
| fabs |
| floor |
| log |
| log10 |
| pow |
| rand |
| sin |
| sqrt |
| srand |
| tan |
| Symbol |
|---|
| format |
| lstrip |
| rstrip |
| split |
| strip |
| Symbol |
|---|
| array |
| assert |
| collectgarbage |
| compilestring |
| developer |
| DoEntFire |
| DoUniqueString |
| dummy |
| enabledebuginfo |
| getconsttable |
| GetFunctionSignature |
| getroottable |
| getstackinfos |
| newthread |
| setconsttable |
| setdebughook |
| seterrorhandler |
| setroottable |
| suspend |
| type |
| Signature | Returns | Description |
|---|---|---|
| GetAttachmentAngles(int) | Vector | Get the attachement id’s angles as a p,y,r vector |
| GetAttachmentOrigin(int) | Vector | Get the attachement id’s origin vector |
| GetObjectScaleLevel() | int | The scale size of the entity |
| GetSequence() | string | Gets the name of the current sequence |
| IsSequenceFinished() | bool | Ask whether the main sequence is done playing |
| LookupAttachment(string) | int | Get the named attachement id |
| SetBodygroup(int, int) | void | Sets a bodygroup |
| SetPoseParameter(string, float) | void | Sets a pose parameter |
| Signature | Returns | Description |
|---|---|---|
| ConnectOutput(string, string) | void | Adds an I/O connection that will call the named function when the specified output fires |
| Destroy() | void | |
| DisconnectOutput(string, string) | void | Removes a connected script function from an I/O event. |
| EmitSound(string) | void | Plays a sound from this entity. |
| entindex() | int | |
| EyePosition() | Vector | Get vector to eye position - absolute coords |
| FirstMoveChild() | handle | |
| GetAngles() | Vector | Get entity pitch, yaw, roll as a vector |
| GetAngularVelocity() | Vector | Get the local angular velocity - returns a vector of pitch,yaw,roll |
| GetBoundingMaxs() | Vector | Get a vector containing max bounds, centered on object |
| GetBoundingMins() | Vector | Get a vector containing min bounds, centered on object |
| GetCenter() | Vector | Get vector to center of object - absolute coords |
| GetClassname() | string | |
| GetForwardVector() | Vector | Get the forward vector of the entity |
| GetHealth() | int | |
| GetLeftVector() | Vector | Get the left vector of the entity |
| GetMaxHealth() | int | |
| GetModelKeyValues() | handle | Get a KeyValue class instance on this entity’s model |
| GetModelName() | string | Returns the name of the model |
| GetMoveParent() | handle | If in hierarchy, retrieves the entity’s parent |
| GetName() | string | |
| GetOrigin() | Vector | |
| GetOwner() | handle | Gets this entity’s owner |
| GetPreTemplateName() | string | Get the entity name stripped of template unique decoration |
| GetRootMoveParent() | handle | If in hierarchy, walks up the hierarchy to find the root parent |
| GetScriptId() | string | Retrieve the unique identifier used to refer to the entity within the scripting system |
| GetScriptScope() | handle | Retrieve the script-side data associated with an entity |
| GetSoundDuration(string, string) | float | Returns float duration of the sound. Takes soundname and optional actormodelname. |
| GetTeam() | int | |
| GetUpVector() | Vector | Get the up vector of the entity |
| GetVelocity() | Vector | |
| NextMovePeer() | handle | |
| PrecacheSoundScript(string) | void | Precache a sound for later playing. |
| SetAbsOrigin(Vector) | void | SetAbsOrigin |
| SetAngles(float, float, float) | void | Set entity pitch, yaw, roll |
| SetAngularVelocity(float, float, float) | void | Set the local angular velocity - takes float pitch,yaw,roll velocities |
| SetForwardVector(Vector) | void | Set the orientation of the entity to have this forward vector |
| SetHealth(int) | void | |
| SetMaxHealth(int) | void | |
| SetModel(string) | void | |
| SetName(string) | void | |
| SetOrigin(Vector) | void | |
| SetOwner(handle) | void | Sets this entity’s owner |
| SetSize(Vector, Vector) | void | |
| SetTeam(int) | void | |
| SetVelocity(Vector) | void | |
| ValidateScriptScope() | bool | Ensure that an entity’s script scope has been created |
| Signature | Returns | Description |
|---|---|---|
| GetCurrentScene() | handle | Returns the instance of the oldest active scene entity (if any). |
| GetSceneByIndex(int) | handle | Returns the instance of the scene entity at the specified index. |
| Field |
|---|
| __KeyValueFromFloat |
| __KeyValueFromInt |
| __KeyValueFromString |
| __KeyValueFromVector |
| ConnectOutput |
| Destroy |
| DisconnectOutput |
| EmitSound |
| entindex |
| EyePosition |
| FirstMoveChild |
| GetAngles |
| GetAngularVelocity |
| GetAttachmentAngles |
| GetAttachmentOrigin |
| GetBoundingMaxs |
| GetBoundingMins |
| GetCenter |
| GetClassname |
| GetForwardVector |
| GetHealth |
| GetLeftVector |
| GetMaxHealth |
| GetModelKeyValues |
| GetModelName |
| GetMoveParent |
| GetName |
| GetObjectScaleLevel |
| GetOrigin |
| GetOwner |
| GetPreTemplateName |
| GetRootMoveParent |
| GetScriptId |
| GetScriptScope |
| GetSequence |
| GetSoundDuration |
| GetTeam |
| GetUpVector |
| GetVelocity |
| IsNoclipping |
| IsSequenceFinished |
| IsValid |
| LookupAttachment |
| NextMovePeer |
| PrecacheSoundScript |
| SetAbsOrigin |
| SetAngles |
| SetAngularVelocity |
| SetBodygroup |
| SetForwardVector |
| SetHealth |
| SetMaxHealth |
| SetModel |
| SetName |
| SetOrigin |
| SetOwner |
| SetPoseParameter |
| SetSize |
| SetTeam |
| SetVelocity |
| ValidateScriptScope |
| Signature | Returns | Description |
|---|---|---|
| IsNoclipping() | bool | Returns true if the player is in noclip mode. |
| Field | Value |
|---|---|
| Call | |
| chains | null |
| constructor | |
| PostScriptExecute | |
| prefix | null |
| scope | null |
| Signature | Returns | Description |
|---|---|---|
| CreateByClassname(string) | handle | Creates an entity by classname |
| FindByClassname(handle, string) | handle | Find entities by class name. Pass ‘null’ to start an iteration, or reference to a previously found entity to continue a search |
| FindByClassnameNearest(string, Vector, float) | handle | Find entities by class name nearest to a point. |
| FindByClassnameWithin(handle, string, Vector, float) | handle | 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 |
| FindByModel(handle, string) | handle | Find entities by model name. Pass ‘null’ to start an iteration, or reference to a previously found entity to continue a search |
| FindByName(handle, string) | handle | Find entities by name. Pass ‘null’ to start an iteration, or reference to a previously found entity to continue a search |
| FindByNameNearest(string, Vector, float) | handle | Find entities by name nearest to a point. |
| FindByNameWithin(handle, string, Vector, float) | handle | Find entities by name within a radius. Pass ‘null’ to start an iteration, or reference to a previously found entity to continue a search |
| FindByTarget(handle, string) | handle | Find entities by targetname. Pass ‘null’ to start an iteration, or reference to a previously found entity to continue a search |
| FindInSphere(handle, Vector, float) | handle | Find entities within a radius. Pass ‘null’ to start an iteration, or reference to a previously found entity to continue a search |
| First() | handle | Begin an iteration over the list of entities |
| Next(handle) | handle | Continue an iteration over the list of entities, providing reference to a previously found entity |
| Signature | Returns | Description |
|---|---|---|
| SpawnEntity() | void | Create an entity at the location of the maker |
| SpawnEntityAtEntityOrigin(handle) | void | Create an entity at the location of a specified entity instance |
| SpawnEntityAtLocation(Vector, Vector) | void | Create an entity at a specified location and orientaton, orientation is Euler angle in degrees (pitch, yaw, roll) |
| SpawnEntityAtNamedEntityOrigin(string) | void | Create an entity at the location of a named entity |
| Signature | Returns | Description |
|---|---|---|
| IsPhoneUp() | bool | Returns true if the player has the phone up. |
| Signature | Returns | Description |
|---|---|---|
| GetPartnerInstance() | handle | Get the instance handle of the door’s linked partner |
| GetPartnername() | string | Returns the partnername of the door. |
| Signature | Returns | Description |
|---|---|---|
| GetPlayerSpeechDuration(int) | float | Returns the number of seconds the player has been continuously speaking. |
| IsPlayerSpeaking(int) | bool | Returns whether the player specified is speaking. |
| Signature | Returns | Description |
|---|---|---|
| GetWheatleyMonitorDestructionCount() | int | Get number of wheatley monitors destroyed by the player. |
| IncWheatleyMonitorDestructionCount() | void | Set number of wheatley monitors destroyed by the player. |
| TurnOffPotatos() | void | Turns Off the Potatos material light |
| TurnOnPotatos() | void | Turns On the Potatos material light |
| Signature | Returns | Description |
|---|---|---|
| GetPartnerInstance() | handle | Get the instance handle of the door’s linked partner |
| GetPartnername() | string | Returns the partnername of the door. |
| Signature | Returns | Description |
|---|---|---|
| AddBroadcastTeamTarget(int) | void | Adds a team (by index) to the broadcast list |
| EstimateLength() | float | Returns length of this scene in seconds. |
| FindNamedEntity(string) | handle | given an entity reference, such as !target, get actual entity from scene object |
| IsPaused() | bool | If this scene is currently paused. |
| IsPlayingBack() | bool | If this scene is currently playing. |
| LoadSceneFromString(string, string) | bool | given a dummy scene name and a vcd string, load the scene |
| RemoveBroadcastTeamTarget(int) | void | Removes a team (by index) from the broadcast list |
| Signature | Returns | Description |
|---|---|---|
| FindKey(string) | handle | Given a KeyValues object and a key name, find a KeyValues object associated with the key name |
| GetFirstSubKey() | handle | Given a KeyValues object, return the first sub key object |
| GetKeyBool(string) | bool | Given a KeyValues object and a key name, return associated bool value |
| GetKeyFloat(string) | float | Given a KeyValues object and a key name, return associated float value |
| GetKeyInt(string) | int | Given a KeyValues object and a key name, return associated integer value |
| GetKeyString(string) | string | Given a KeyValues object and a key name, return associated string value |
| GetNextKey() | handle | Given a KeyValues object, return the next key object in a sub key group |
| IsKeyEmpty(string) | bool | Given a KeyValues object and a key name, return true if key name has no value |
| ReleaseKeyValues() | void | Given a root KeyValues object, release its contents |
| Field | Value |
|---|---|
| Call | |
| chain | null |
| constructor | |
| exactMatch | false |
| PostScriptExecute | |
| prefix | null |
| scope | null |
| Signature | Returns | Description |
|---|---|---|
| GetFov() | int | get camera’s current fov setting as integer |
| SetFov(int, float) | void | set camera’s current fov in integer degrees and fov change rate as float |
| Field | Value |
|---|---|
| Begin | |
| End | |
| EstablishDelegation | |
| HookRootMetamethod | |
| Log | |
| m_bindNamesStack | |
| m_fixupSet | |
| m_log | false |
| m_logIndent | 0 |
| m_targetTable | null |
| RemoveDelegation | |
| Resolve | |
| UnhookRootMetamethod |
| Field |
|---|
| capture |
| constructor |
| match |
| search |
| subexpcount |
| Field |
|---|
| constructor |
| Cross |
| Dot |
| Length |
| Length2D |
| Length2DSqr |
| LengthSqr |
| Norm |
| ToKVString |