Alien Swarm/Scripting/Script Functions

script_help dump

Function:    CBaseEntity::ConnectOutput
Signature:   void CBaseEntity::ConnectOutput(string, string)
Description: Adds an I/O connection that will call the named function when the specified output fires

Function:    CBaseEntity::Destroy
Signature:   void CBaseEntity::Destroy()

Function:    CBaseEntity::DisconnectOutput
Signature:   void CBaseEntity::DisconnectOutput(string, string)
Description: Removes a connected script function from an I/O event.

Function:    CBaseEntity::EmitSound
Signature:   void CBaseEntity::EmitSound(string)
Description: Plays a sound from this entity.

Function:    CBaseEntity::EyePosition
Signature:   Vector CBaseEntity::EyePosition()
Description: Get vector to eye position - absolute coords

Function:    CBaseEntity::FirstMoveChild
Signature:   handle CBaseEntity::FirstMoveChild()

Function:    CBaseEntity::GetAngles
Signature:   Vector CBaseEntity::GetAngles()
Description: Get entity pitch, yaw, roll as a vector

Function:    CBaseEntity::GetAngularVelocity
Signature:   Vector CBaseEntity::GetAngularVelocity()
Description: Get the local angular velocity - returns a vector of pitch,yaw,roll

Function:    CBaseEntity::GetBoundingMaxs
Signature:   Vector CBaseEntity::GetBoundingMaxs()
Description: Get a vector containing max bounds, centered on object

Function:    CBaseEntity::GetBoundingMins
Signature:   Vector CBaseEntity::GetBoundingMins()
Description: Get a vector containing min bounds, centered on object

Function:    CBaseEntity::GetCenter
Signature:   Vector CBaseEntity::GetCenter()
Description: Get vector to center of object - absolute coords

Function:    CBaseEntity::GetClassname
Signature:   string CBaseEntity::GetClassname()

Function:    CBaseEntity::GetForwardVector
Signature:   Vector CBaseEntity::GetForwardVector()
Description: Get the forward vector of the entity

Function:    CBaseEntity::GetHealth
Signature:   int CBaseEntity::GetHealth()

Function:    CBaseEntity::GetLeftVector
Signature:   Vector CBaseEntity::GetLeftVector()
Description: Get the left vector of the entity

Function:    CBaseEntity::GetMaxHealth
Signature:   int CBaseEntity::GetMaxHealth()

Function:    CBaseEntity::GetModelKeyValues
Signature:   handle CBaseEntity::GetModelKeyValues()
Description: Get a KeyValue class instance on this entity's model

Function:    CBaseEntity::GetModelName
Signature:   string CBaseEntity::GetModelName()
Description: Returns the name of the model

Function:    CBaseEntity::GetMoveParent
Signature:   handle CBaseEntity::GetMoveParent()
Description: If in hierarchy, retrieves the entity's parent

Function:    CBaseEntity::GetName
Signature:   string CBaseEntity::GetName()

Function:    CBaseEntity::GetOrigin
Signature:   Vector CBaseEntity::GetOrigin()

Function:    CBaseEntity::GetOwner
Signature:   handle CBaseEntity::GetOwner()
Description: Gets this entity's owner

Function:    CBaseEntity::GetPreTemplateName
Signature:   string CBaseEntity::GetPreTemplateName()
Description: Get the entity name stripped of template unique decoration

Function:    CBaseEntity::GetRootMoveParent
Signature:   handle CBaseEntity::GetRootMoveParent()
Description: If in hierarchy, walks up the hierarchy to find the root parent

Function:    CBaseEntity::GetScriptId
Signature:   string CBaseEntity::GetScriptId()
Description: Retrieve the unique identifier used to refer to the entity within the scripting system

Function:    CBaseEntity::GetScriptScope
Signature:   handle CBaseEntity::GetScriptScope()
Description: Retrieve the script-side data associated with an entity

Function:    CBaseEntity::GetSoundDuration
Signature:   float CBaseEntity::GetSoundDuration(string, string)
Description: Returns float duration of the sound. Takes soundname and optional actormodelname.

Function:    CBaseEntity::GetTeam
Signature:   int CBaseEntity::GetTeam()

Function:    CBaseEntity::GetUpVector
Signature:   Vector CBaseEntity::GetUpVector()
Description: Get the up vector of the entity

Function:    CBaseEntity::GetVelocity
Signature:   Vector CBaseEntity::GetVelocity()

Function:    CBaseEntity::NextMovePeer
Signature:   handle CBaseEntity::NextMovePeer()

Function:    CBaseEntity::PrecacheSoundScript
Signature:   void CBaseEntity::PrecacheSoundScript(string)
Description: Precache a sound for later playing.

Function:    CBaseEntity::SetAbsOrigin
Signature:   void CBaseEntity::SetAbsOrigin(Vector)
Description: SetAbsOrigin

Function:    CBaseEntity::SetAngles
Signature:   void CBaseEntity::SetAngles(float, float, float)
Description: Set entity pitch, yaw, roll

Function:    CBaseEntity::SetAngularVelocity
Signature:   void CBaseEntity::SetAngularVelocity(float, float, float)
Description: Set the local angular velocity - takes float pitch,yaw,roll velocities

Function:    CBaseEntity::SetForwardVector
Signature:   void CBaseEntity::SetForwardVector(Vector)
Description: Set the orientation of the entity to have this forward vector

Function:    CBaseEntity::SetHealth
Signature:   void CBaseEntity::SetHealth(int)

Function:    CBaseEntity::SetMaxHealth
Signature:   void CBaseEntity::SetMaxHealth(int)

Function:    CBaseEntity::SetModel
Signature:   void CBaseEntity::SetModel(string)

Function:    CBaseEntity::SetOrigin
Signature:   void CBaseEntity::SetOrigin(Vector)

Function:    CBaseEntity::SetOwner
Signature:   void CBaseEntity::SetOwner(handle)
Description: Sets this entity's owner

Function:    CBaseEntity::SetSize
Signature:   void CBaseEntity::SetSize(Vector, Vector)

Function:    CBaseEntity::SetTeam
Signature:   void CBaseEntity::SetTeam(int)

Function:    CBaseEntity::SetVelocity
Signature:   void CBaseEntity::SetVelocity(Vector)

Function:    CBaseEntity::ValidateScriptScope
Signature:   bool CBaseEntity::ValidateScriptScope()
Description: Ensure that an entity's script scope has been created

Function:    CBaseEntity::entindex
Signature:   int CBaseEntity::entindex()

Function:    CEntities::CreateByClassname
Signature:   handle CEntities::CreateByClassname(string)
Description: Creates an entity by classname

Function:    CEntities::FindByClassname
Signature:   handle CEntities::FindByClassname(handle, string)
Description: Find entities by class name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search

Function:    CEntities::FindByClassnameNearest
Signature:   handle CEntities::FindByClassnameNearest(string, Vector, float)
Description: Find entities by class name nearest to a point.

Function:    CEntities::FindByClassnameWithin
Signature:   handle CEntities::FindByClassnameWithin(handle, string, Vector, float)
Description: 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

Function:    CEntities::FindByModel
Signature:   handle CEntities::FindByModel(handle, string)
Description: Find entities by model name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search

Function:    CEntities::FindByName
Signature:   handle CEntities::FindByName(handle, string)
Description: Find entities by name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search

Function:    CEntities::FindByNameNearest
Signature:   handle CEntities::FindByNameNearest(string, Vector, float)
Description: Find entities by name nearest to a point.

Function:    CEntities::FindByNameWithin
Signature:   handle CEntities::FindByNameWithin(handle, string, Vector, float)
Description: Find entities by name within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search

Function:    CEntities::FindByTarget
Signature:   handle CEntities::FindByTarget(handle, string)
Description: Find entities by targetname. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search

Function:    CEntities::FindInSphere
Signature:   handle CEntities::FindInSphere(handle, Vector, float)
Description: Find entities within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search

Function:    CEntities::First
Signature:   handle CEntities::First()
Description: Begin an iteration over the list of entities

Function:    CEntities::Next
Signature:   handle CEntities::Next(handle)
Description: Continue an iteration over the list of entities, providing reference to a previously found entity

Function:    CreateProp
Signature:   handle CreateProp(string, Vector, string, int)
Description: Create a physics prop

Function:    CreateSceneEntity
Signature:   handle CreateSceneEntity(string)
Description: Create a scene entity to play the specified scene.

Function:    DebugDrawBox
Signature:   void DebugDrawBox(Vector, Vector, Vector, int, int, int, int, float)
Description: Draw a debug overlay box

Function:    DebugDrawLine
Signature:   void DebugDrawLine(Vector, Vector, int, int, int, bool, float)
Description: Draw a debug overlay box

Function:    DoIncludeScript
Signature:   bool DoIncludeScript(string, handle)
Description: Execute a script (internal)

Function:    EntFire
Signature:   function EntFire(target, action, value, delay, activator)
Description: Generate and entity i/o event

Function:    EntFireByHandle
Signature:   void EntFireByHandle(handle, string, string, float, handle, handle)
Description: Generate and entity i/o event. First parameter is an entity instance.

Function:    FrameTime
Signature:   float FrameTime()
Description: Get the time spent on the server in the last frame

Function:    GetMapName
Signature:   string GetMapName()
Description: Get the name of the map.

Function:    RandomFloat
Signature:   float RandomFloat(float, float)
Description: Generate a random floating point number within a range, inclusive

Function:    RandomInt
Signature:   int RandomInt(int, int)
Description: Generate a random integer within a range, inclusive

Function:    SendToConsole
Signature:   void SendToConsole(string)
Description: Send a string to the console as a command

Function:    ShowMessage
Signature:   void ShowMessage(string)
Description: Print a hud message on all clients

Function:    Time
Signature:   float Time()
Description: Get the current server time

Function:    TraceLine
Signature:   float TraceLine(Vector, Vector, handle)
Description: given 2 points & ent to ignore, return fraction along line that hits world or models

Function:    UniqueString
Signature:   function UniqueString(string)
Description: 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.