View source for List of Counter-Strike: Global Offensive Script Functions:zh-cn

{{otherlang2
|en=List_of_Counter-Strike:_Global_Offensive_Script_Functions
}}

{{toc-right}}

{{sq}} 这份清单包含了{{game link|Counter-Strike: Global Offensive}}中的与引擎相关的可用于[[VScript]]的[[Squirrel]]类、函数以及可用的变量. 加载一个地图然后执行<code>script_help</code>, 并且将<code>developer</code>的级别设置为至少1, 可以把这份清单中的部分内容显示于控制台中.  值得一提的是, <code>developer</code>的级别只要不为0, 且加载了任意的地图, 就可以把<code>script_help</code>指令所显示的内容转存到文件中. 步骤如下（请一步一步地在控制台中键入每一行指令）：

<code>
 developer 3
 map de_nuke
 developer 0
 con_logfile dump.log
 script_help
 con_logfile ""
</code>



这条内容由[//steamcommunity.com/id/utagawashii/ Dazai Nerau]译自英文版页面. 欢迎任何人补充新内容或者修改其中的错误.




== 变量 ==

{| class="standard-table" 
!实例
!类型
!描述
|-
|<code>Entities</code>
|<code>[[#CEntities|CEntities]]</code>
|提供一个对当前已生成的实体的访问方式.
|-
|}

== 常量 ==
{| class="standard-table"
!实例
!类型
!描述
|-
|<code>_charsize_</code>
|integer
| 
|-
|<code>_floatsize_</code>
|integer
| 
|-
|<code>_intsize_</code>
|integer
| 
|-
|<code>_version_</code>
|string
| Squirrel的版本号.
|-
|<code>_versionnumber_</code>
|integer
| Squirrel的版本号的整数形式.
|-
|<code>RAND_MAX</code>
|integer
| 
|-
|}

== 类 ==


=== CBaseEntity ===
CBaseEntity是实体的脚本句柄类. 所有已生成的实体都有一个使用CBaseEntity或者其子类的的脚本句柄.

所有游戏中的脚本句柄都可以从[[#CEntities|Entities]]中访问. 实体脚本可以通过 <code>self</code>来访问它们自身的脚本句柄.

==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>__KeyValueFromInt</code>
| <code>void __KeyValueFromInt(string ''key'', int ''value'')</code>
| 以整数设置实体的[[Keyvalue|键值（KeyValue）]]. 这个函数只修改数值而不执行实体处理KeyValue所需要的任何代码, 所以可能会有令人意想不到的副作用.
|-
| <code>__KeyValueFromFloat</code>
| <code>void __KeyValueFromFloat(string ''key'', float ''value'')</code>
| 以浮点数设置实体的KeyValue. 这个函数只修改数值而不执行实体处理KeyValue所需要的任何代码, 所以可能会有令人意想不到的副作用.
|-
| <code>__KeyValueFromString</code>
| <code>void __KeyValueFromString(string ''key'', string ''value'')</code>
| 以字符串设置实体的KeyValue. 这个函数只修改数值而不执行实体处理KeyValue所需要的任何代码, 所以可能会有令人意想不到的副作用.
|-
| <code>__KeyValueFromVector</code>
| <code>void __KeyValueFromVector(string ''key'', Vector ''value'')</code>
| 以[[#Vector|向量（Vector）]]设置实体的KeyValue. 这个函数只修改数值而不执行实体处理KeyValue所需要的任何代码, 所以可能会有令人意想不到的副作用.
|-
| <code>ConnectOutput</code>
| <code>void ConnectOutput(string ''output'', string ''function'')</code>
| 添加一个I/O关联, 当指定的输出触发时将调用指定的函数.
|-
| <code>DisconnectOutput</code>
| <code>void DisconnectOutput(string ''output'', string ''function'')</code>
| 从I/O事件中删除一个已关联的脚本函数.
|-
| <code>Destroy</code>
| <code>void Destroy()</code>
| 删除实体.
|-
| <code>EmitSound</code>
| <code>void EmitSound(string ''soundScript'')</code>
| 在这个实体上播放声音.
|-
| <code>entindex</code>
| <code>int entindex()</code>
| 返回实体的索引.
|-
| <code>EyePosition</code>
| <code>Vector EyePosition()</code>
| 获取眼睛位置的向量（备注：绝对坐标）.
|-
| <code>FirstMoveChild</code>
| <code>handle FirstMoveChild()</code>
| 无
|-
| <code>GetAngles</code>
| <code>Vector GetAngles()</code>
| 以[[#Vector|向量]]形式获取实体的欧拉角(pitch, yaw, roll).
|-
| <code>GetAngularVelocity</code>
| <code>Vector GetAngularVelocity()</code>
| 获取实体的角速度（备注：返回pitch、yaw、roll的向量）.
|-
| <code>GetBoundingMaxs</code>
| <code>Vector GetBoundingMaxs()</code>
| 将实体边界框的最大范围以向量返回。
|-
| <code>GetBoundingMins</code>
| <code>Vector GetBoundingMins()</code>
| 将实体边界框的最小范围以向量返回.
|-
| <code>GetCenter</code>
| <code>Vector GetCenter()</code>
| 返回边界框中心位置的向量.
|-
| <code>GetClassname</code>
| <code>string GetClassname()</code>
| 返回实体的种类名. （备注：包含<code>player</code>）.
|-
| <code>GetForwardVector</code>
| <code>Vector GetForwardVector()</code>
| 返回实体的前向量.
|-
| <code>GetHealth</code>
| <code>int GetHealth()</code>
| 返回实体当前的生命值.
|-
| <code>GetLeftVector</code>
| <code>Vector GetLeftVector()</code>
| 返回实体的左向量.
|-
| <code>GetMaxHealth</code>
| <code>int GetMaxHealth()</code>
| 返回实体的最大生命值.
|-
| <code>GetModelKeyValues</code>
| <code>Keyvalues GetModelKeyValues()</code>
| 返回实体模型的[$keyvalues]块作为一个[[#Keyvalues]]对象. 请注意, 这并非实体自身的keyvalues.
|-
| <code>GetModelName</code>
| <code>string GetModelName()</code>
| 返回实体模型的文件名.
|-
| <code>GetMoveParent</code>
| <code>CBaseEntity GetMoveParent()</code>
| 如果实体位于层次结构(hierarchy)中, 检索实体的父级(parent).
|-
| <code>GetName</code>
| <code>string GetName()</code>
| 返回实体的targetname.
|-
| <code>GetOrigin</code>
| <code>Vector GetOrigin()</code>
| 返回实体的位置.
|-
| <code>GetOwner</code>
| <code>handle GetOwner()</code>
| 获取实体的所有者(owner). (备注：似乎只有当需要在这个实体上使用SetOwner()时这个函数才有用, 可能也不尽然)
|-
| <code>GetPreTemplateName</code>
| <code>string GetPreTemplateName()</code>
| Get the entity name stripped of template unique decoration.
|-
| <code>GetRootMoveParent</code>
| <code>handle GetRootMoveParent()</code>
| 如果实体位于层次结构中，顺着层次结构检索实体的根父级.
|-
| <code>GetScriptId</code>
| <code>string GetScriptId()</code>
| 检索用于引用脚本系统中的实体的唯一标识符.
|-
| <code>GetScriptScope</code>
| <code>handle GetScriptScope()</code>
| 检索存储与此实体关联的实体脚本数据的表.
|-
| <code>GetSoundDuration</code>
| <code>float GetSoundDuration(string ''soundName'', string ''actorModelName'' = "")</code>
| 以浮点数返回声音的持续时间. （备注：采用"soundName"和可选的"actorModelName"作为搜索参数）
|-
| <code>GetTeam</code>
| <code>int GetTeam()</code>
| 返回玩家的队伍. （备注：观察者 = 1, 恐怖分子 = 2, 反恐精英 = 3）.
|-
| <code>GetUpVector</code>
| <code>Vector GetUpVector()</code>
| 获取实体的顶向量.
|-
| <code>GetVelocity</code>
| <code>Vector GetVelocity()</code>
| 返回实体的速度向量.
|-
| <code>IsValid</code>
| <code>bool IsValid()</code>
| 返回句柄是否属于有效的实体.
|-
| <code>NextMovePeer</code>
| <code>handle NextMovePeer()</code>
| 无
|-
| <code>PrecacheModel</code>
| <code>void PrecacheModel(string ''modelPath'')</code>
| 在地图加载完成后预缓存一个模型.
|-
| <code>PrecacheScriptSound</code>
| <code>void PrecacheScriptSound(string ''soundName'')</code>
| 无
|-
| <code>PrecacheSoundScript</code>
| <code>void PrecacheSoundScript(string ''soundScript'')</code>
| 预缓存一个将会被播放的声音.
|-
| <code>SetAbsOrigin</code>
| <code>void SetAbsOrigin(Vector ''position'')</code>
| 与SetOrigin()功能相同.
|-
| <code>SetAngles</code>
| <code>void SetAngles(float ''pitch'', float ''yaw'', float ''roll'')</code>
| 设置实体的pitch, yaw, roll. 请注意, 这里并不使用向量.
|-
| <code>SetAngularVelocity</code>
| <code>void SetAngularVelocity(float ''pitch'', float ''yaw'', float ''roll'')</code>
| 设置实体的角速度.（备注：采用pitch, yaw和roll的浮点数形式的角速度）.
|-
| <code>SetForwardVector</code>
| <code>void SetForwardVector(Vector ''forwardVector'')</code>
| 设置实体的前向量.
|-
| <code>SetHealth</code>
| <code>void SetHealth(int ''newHealth'')</code>
| 设置实体的生命值.
|-
| <code>SetMaxHealth</code>
| <code>void SetMaxHealth(int ''maxHealth'')</code>
| 设置实体的最大生命值.
|-
| <code>SetModel</code>
| <code>void SetModel(string ''modelName'')</code>
| 改变实体的模型, 这个函数并不预缓存模型! {{todo|检查副作用}}
|-
| <code>SetOrigin</code>
| <code>void SetOrigin(Vector ''position'')</code>
| 将实体移动到指定位置.
|-
| <code>SetOwner</code>
| <code>void SetOwner(handle ''owner'')</code>
| 设置实体的所有者.
|-
| <code>SetSize</code>
| <code>void SetSize(Vector, Vector)</code>
| 无
|-
| <code>SetTeam</code>
| <code>void SetTeam(int ''teamNumber'')</code>
| 立即转换玩家的团队. （备注：观察者 = 1, 恐怖分子 = 2, 反恐精英 = 3)
|-
| <code>SetVelocity</code>
| <code>void SetVelocity(Vector ''velocity'')</code>
| 设置实体的速度向量.
|-
| <code>ValidateScriptScope</code>
| <code>bool ValidateScriptScope()</code>
| 返回实体的脚本域是否已被创建.
|-
|}

==== Hooks ====
如果其中一个函数在实体脚本中被声明, 实体将在适当的情况下自动运行此函数.

{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>Input''InputName''</code>
| <code>bool Input''InputName''()</code>
| 当实体从I/O系统中接收到输入时调用. 此函数的名称必须是实体input列表中的<code>Input</code>, 例如表示FireUser1的<code>InputFireUser1</code>. 当这个函数被调用时, 激活和调用的实体的脚本句柄会被写入接收输入的实体的脚本数据的<code>activator</code>和<code>caller</code>变量中. 这个函数必须返回一个布尔值. 将布尔值设定为<code>true</code>允许实体来处理输入, 否则用<code>false</code>阻止之.
|-
| <code>OnPostSpawn</code>
| <code>void OnPostSpawn()</code>
| 在实体生成时立即被调用. 这个函数可以用于让实体向主脚本注册自身，或以编程方式调整实体参数.
|-
| <code>Precache</code>
| <code>void Precache()</code>
| 在脚本执行后调用. 可用于在地图加载时调用模型和声音的预缓存函数.
|}

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

动画实体（如props）的脚本句柄类.

==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>GetAttachmentAngles</code>
| <code>Vector GetAttachmentAngles(int ''id'')</code>
| 以pitch, yaw, roll向量的形式获取附件ID的角度.
|-
| <code>GetAttachmentOrigin</code>
| <code>Vector GetAttachmentOrigin(int 'id')</code>
| 获取附件ID的位置向量.
|-
| <code>IsSequenceFinished</code>
| <code>bool IsSequenceFinished()</code>
| 返回主序列是否已经播放完成.
|-
| <code>LookupAttachment</code>
| <code>int LookupAttachment(string ''attachmentName'')</code>
| 获取指定名字的附件ID.
|-
| <code>SetBodygroup</code>
| <code>void SetBodygroup(int ''groupIndex'', int ''value'')</code>
| 通过索引设置模型的bodygroup的值. {{todo|那么问题来了，要如何才能找到索引？？？}}
|}

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

==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>GetCurrentScene</code>
| <code>handle GetCurrentScene()</code>
| 返回最早的活动场景实体的实例 (备注：如果有的话).
|-
| <code>GetSceneByIndex</code>
| <code>handle GetSceneByIndex(int ''index'')</code>
| 返回指定索引的场景实体的实例.
|}

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

==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>IsNoclipping</code>
| <code>bool IsNoclipping()</code>
| 返回玩家是否处于noclip状态.
|}

=== CBaseMultiplayerPlayer ===
Extends [[#CBasePlayer|CBasePlayer]]

CSGO玩家的脚本句柄类，无附带方法。


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

[[env_entity_maker]]的脚本句柄类. 

==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>SpawnEntity</code>
| <code>void SpawnEntity()</code>
| 在制造器的位置上创建一个实体
|-
| <code>SpawnEntityAtEntityOrigin</code>
| <code>void SpawnEntityAtEntityOrigin(CBaseEntity ''entity'')</code>
| 在指定实体实例的位置上创建一个实体.
|-
| <code>SpawnEntityAtLocation</code>
| <code>void SpawnEntityAtLocation(Vector ''origin'', Vector ''orientation'')</code>
| 在指定的位置和方向上创建一个实体，方向为以度为单位的欧拉角(pitch, yaw, roll).
|-
| <code>SpawnEntityAtNamedEntityOrigin</code>
| <code>void SpawnEntityAtNamedEntityOrigin(string ''targetName'')</code>
| 在一个指定名字的实体的位置上创建一个实体。
|}

=== CFuncTrackTrain ===
Extends [[#CFuncTrackTrain|CFuncTrackTrain]]

==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>GetFuturePosition</code>
| <code>Vector GetFuturePosition(float, float)</code>
| 获取track在未来X秒的内的位置.
|}

=== CGameCoopMissionManager ===
Extends [[#CGameCoopMissionManager|CGameCoopMissionManager]]

==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>GetWaveNumber</code>
| <code>int GetWaveNumber()</code>
| 获取玩家已经完成的合作模式波数.
|}

=== CHostage ===
Extends [[#CGameCoopMissionManager|CGameCoopMissionManager]]

==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>IsBeingCarried</code>
| <code>bool IsBeingCarried()</code>
| 返回人质当前是否正在被护送.
|}



=== CPointTemplate ===
Extends [[#CBaseEntity|CBaseEntity]]

[[point_template]]的脚本句柄类.

==== Hooks ====

;<code>table PreSpawnInstance(string ''entityClass'', string ''entityName'')</code>
:如果定义了此Hook，它将在实体创建之前被调用，并且返回的任何KeyValues都将被分配给该实体。

<source lang="cpp">function PreSpawnInstance( entityClass, entityName )
{
	local keyvalues =
	{ 
   		rendercolor = "0 255 0"
   		targetname = "mySpawnedEntity"
	}
	return keyvalues
	
}
</source>

;<code>void PostSpawn(table ''entities'')</code>
:在实体生成后调用. 具有按名称索引的已生成的实体句柄的表被传递给该函数. 可以使用它来关联输出或在创建实体后做任何你想做的事情.

<source lang="cpp">function PostSpawn( entities )
{
	foreach( name, handle in entities )
	{
		printl( name + ": " + handle )
	}
}
</source>


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


==== Methods ====

{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>AddBroadcastTeamTarget</code>
| <code>void AddBroadcastTeamTarget(int ''index'')</code>
| 添加一个队伍(通过索引)到广播列表中.
|-
| <code>EstimateLength</code>
| <code>float EstimateLength()</code>
| 以秒为单位返回此场景的长度.
|-
| <code>FindNamedEntity</code>
| <code>handle FindNamedEntity(string ''reference'')</code>
| 给定一个实体参照, 比如 !target, 以从场景对象中获取真正的实体.
|-
| <code>IsPaused</code>
| <code>bool IsPaused()</code>
| 返回这个场景是否暂停.
|-
| <code>IsPlayingBack</code>
| <code>bool IsPlayingBack()</code>
| 返回这个场景是否正在播放.
|-
| <code>LoadSceneFromString</code>
| <code>bool LoadSceneFromString(string ''sceneName'', string ''scene'')</code>
| 给定一个虚拟的场景名和vcd的字符串, 以加载场景.
|-
| <code>RemoveBroadcastTeamTarget</code>
| <code>void RemoveBroadcastTeamTarget(int ''index'')</code>
| 从广播列表中删除一个队伍（通过索引）.
|}


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


==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>GetFov</code>
| <code>int GetFov()</code>
| 以整数获取当前相机的FOV设置.
|-
| <code>SetFov</code>
| <code>void SetFov(int ''fov'', float ''rate'')</code>
| 用整数的度数设置相机的FOV, 用浮点数设置FOV的变化率.
|}

==== Hooks ====

;<code>void ScriptStartCameraShot(string ''shotType'', handle ''sceneEntity'', handle ''actor1'', handle ''actor2'', float ''duration'')</code>
: ''由SceneEntity调用以响应由一个VCD发送来的CChoreoEvent::CAMERA.'' {{todo}}


=== CCallChainer ===
{{todo}}

==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>constructor</code>
| <code>{{todo}} constructor()</code>
| 
|-
| <code>PostScriptExecute</code>
| <code>{{todo}} PostScriptExecute()</code>
| 
|-
| <code>Call</code>
| <code>{{todo}} Call()</code>
| 
|}

==== Members ====
{| class="standard-table" style="width: 100%;"
! 实例
! 类型
! 描述
|-
| <code>chains</code>
| <code>null</code>
| 
|-
| <code>prefix</code>
| <code>null</code>
| 
|-
| <code>scope</code>
| <code>null</code>
| 
|}


=== CEntities ===
游戏实例: <code>Entities</code>

一个用于查找和遍历所有游戏中的实体的脚本句柄的接口.
要遍历一组实体, 请将<code>null</code>传递给适当方法中的前置参数以开始遍历, 或引用先前找到的实体以继续搜索.

==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>CreateByClassname</code>
| <code>handle CreateByClassname(string ''class'')</code>
| 通过种类名(class name)创建一个实体.
|-
| <code>FindByClassname</code>
| <code>handle FindByClassname(handle ''previous'', string ''class'')</code>
| 通过种类名寻找一个实体.
|-
| <code>FindByClassnameNearest</code>
| <code>handle FindByClassnameNearest(string ''class'', Vector ''origin'', float ''radius'')</code>
| 查找最接近指定点的指定种类名的实体.
|-
| <code>FindByClassnameWithin</code>
| <code>handle FindByClassnameWithin(handle ''previous'', string ''class'', Vector ''origin'', float ''radius'')</code>
| 在一个范围内查找一个指定种类名的实体. 
|-
| <code>FindByModel</code>
| <code>handle FindByModel(handle ''previous'', string ''filename'')</code>
| 通过模型名查找一个实体.
|-
| <code>FindByName</code>
| <code>handle FindByName(handle ''previous'', string ''name'')</code>
| 通过targetname查找一个实体.
|-
| <code>FindByNameNearest</code>
| <code>handle FindByNameNearest(string ''name'', Vector ''origin'', float ''radius'')</code>
| 查找最接近指定点的指定targetname的实体.
|-
| <code>FindByNameWithin</code>
| <code>handle FindByNameWithin(handle ''previous'', string ''name'', Vector ''origin'', float ''radius'')</code>
| 在一个范围内查找一个指定targetname的实体.
|-
| <code>FindByTarget</code>
| <code>handle FindByTarget(handle ''previous'', string ''targetname'')</code>
| 通过实体自身的target查找一个实体.
|-
| <code>FindInSphere</code>
| <code>handle FindInSphere(handle ''previous'', Vector ''origin'', float ''radius'')</code>
| 在一个范围内查找一个实体.
|-
| <code>First</code>
| <code>handle First()</code>
| 开始遍历的实体列表.
|-
| <code>Next</code>
| <code>handle Next(handle ''previous'')</code>
| 继续遍历实体列表, 为先前找到的实体提供参照.
|-
| <code>IsValid</code>
| <code>bool IsValid()</code>
| 返回句柄是否属一个有效的实体.
|}


=== CPlayerVoiceListener ===
{{todo|这些方法里的整数参数究竟是些什么鬼.}}

==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>GetPlayerSpeechDuration</code>
| <code>float GetPlayerSpeechDuration(int)</code>
| 返回玩家持续说话的秒数.
|-
| <code>IsPlayerSpeaking</code>
| <code>bool IsPlayerSpeaking(int)</code>
| 返回指定玩家是否正在说话.
|-
| <code>IsValid</code>
| <code>bool IsValid()</code>
| 返回句柄是否属于一个有效的实体.
|}


=== CScriptKeyValues ===
代表一个模型的[[$keyvalues]]块的脚本句柄.
子键是同一类的实例.

==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>constructor</code>
|-
| <code>FindKey</code>
| <code>CScriptKeyValues FindKey(string ''keyName'')</code>
| 通过键名找到一个子键.
|-
| <code>GetFirstSubKey</code>
| <code>CScriptKeyValues GetFirstSubKey()</code>
| 返回第一个子键对象.
|-
| <code>GetKeyBool</code>
| <code>bool GetKeyBool(string ''keyName'')</code>
| 以布尔形式返回一个键值.
|-
| <code>GetKeyFloat</code>
| <code>float GetKeyFloat(string ''keyName'')</code>
| 以浮点数返回一个键值.
|-
| <code>GetKeyInt</code>
| <code>int GetKeyInt(string ''keyName'')</code>
| 以整数返回一个键值.
|-
| <code>GetKeyString</code>
| <code>string GetKeyString(string ''keyName'')</code>
| 以字符串形式返回一个键值.
|-
| <code>GetNextKey</code>
| <code>handle GetNextKey()</code>
| 将下一个相邻的键对象返回到调用该方法的对象.
|-
| <code>IsKeyEmpty</code>
| <code>bool IsKeyEmpty(string ''keyName'')</code>
| 如果指定的键是空值返回真.
|-
| <code>IsValid</code>
| <code>bool IsValid()</code>
| 返回句柄是否属于一个有效的实体.
|-
| <code>ReleaseKeyValues</code>
| <code>void ReleaseKeyValues()</code>
| 释放实例的内容.
|}


=== CSimpleCallChainer ===
看上去似乎和 [[#CCallChainer|CCallChainer]] 有相同的Members.
{{todo}}


== LateBinder ===
Late binding: allows a table to refer to parts of itself, it's children, it's owner, and then have the references fixed up after it's fully parsed.
<source lang=cpp>
// Usage:
lateBinder <- LateBinder();
lateBinder.Begin( this );

Test1 <-
{   
   Foo=1
}   

Test2 <-
{   
   FooFoo = "I'm foo foo"
   BarBar="@Test1.Foo"
   SubTable = { boo=[bah, "@Test2.FooFoo", "@Test1.Foo"], booboo2={one=bah, two="@Test2.FooFoo", three="@Test1.Foo"} }
   booboo=[bah, "@Test2.FooFoo", "@Test1.Foo"]
   booboo2={one=bah, two="@Test2.FooFoo", three="@Test1.Foo"}
   bah=wha
}   

lateBinder.End();
delete lateBinder;
</source>

When End() is called, all of the unresolved symbols in the tables and arrays will be resolved, any left unresolved will become a string prepended with '~', which later code can deal with.


==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>Begin</code>
|-
| <code>End</code>
|-
| <code>EstablishDelegation</code>
|-
| <code>HookRootMetamethod</code>
|-
| <code>Log</code>
|-
| <code>m_bindNamesStack</code>
|-
| <code>m_fixupSet</code>
|-
| <code>m_log</code>
|-
| <code>m_logIndent</code>
|-
| <code>m_targetTable</code>
|-
| <code>RemoveDelegation</code>
|-
| <code>Resolve</code>
|-
| <code>UnhookRootMetamethod</code>
|}

=== regexp ===
正则表达式的内置[http://squirrel-lang.org/doc/sqstdlib3.html#d0e2591 Squirrel 类].

==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>constructor</code>
| <code>regexp()</code>
| 
|-
| <code>capture</code>
| <code> [table] capture(''str'', [''start''])</code>
| 返回在字符串str中的一个正则表达式的第一个匹配的包含2个索引（"begin"和"end"）的表的数组.为每个捕获的子表达式创建一个数组条目, 如果不匹配, 则返回null. 搜索从字符串的索引开始处开始, 如果忽略start, 则搜索从字符串的起始处开始.
|-
| <code>match</code>
| <code> bool match(''str'')</code>
| 如果正则表达式匹配字符串str， 则返回true， 否则返回false.
|-
| <code>search</code>
| <code>table search(''str'', [''start''])</code>
| 返回包含字符串"str"中正则表达式第一个匹配的两个索引（"begin"和"end"）的表, 如果不匹配, 则返回null. 搜索从字符串的索引开始处开始, 如果忽略start, 则搜索从字符串的起始处开始.
|-
| <code>subexpcount</code>
| 
| 
|}


=== Vector ===
Squirrel的[[Vector]]类与C++相当.

三维向量用向量值和标量值重载了算术运算.

{{注意|声明与操作向量的[http://www.leeland.net/hochsuch.html 例子] }}

==== Methods ====
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>constructor</code>
| <code>Vector(float ''x'', float ''y'', float ''z'')</code>
| 用指定的笛卡尔坐标创建一个新的向量.
|-
| <code>Cross</code>
| <code>float Cross(Vector ''factor'')</code>
| 两个向量的向量乘积. 返回与输入向量正交的向量.
|-
| <code>Dot</code>
| <code>float Dot(Vector ''factor'')</code>
| 两个向量的标量积.
|-
| <code>Length</code>
| <code>float Length()</code>
| 向量的幅度.
|-
| <code>LengthSqr</code>
| <code>float LengthSqr()</code>
| 向量的幅度的平方. 比上一个方法更快.
|-
| <code>Length2D</code>
| <code>float Length2D()</code>
| 返回x-y平面上向量的幅度.
|-
| <code>Length2DSqr</code>
| <code>float Length2DSqr()</code>
| 返回x-y平面上向量幅度的平方. 比上一个方法更快.
|-
| <code>Norm</code>
| <code>float Norm()</code>
| 以浮点数返回向量的长度. 这个函数同时也会将向量'''规范化''', X, Y和Z值将被设置为-1和1之间的数字. 然后你可以将这些值乘以例如3000, 以使用该向量来设置游戏中某物的速度. 
|-
| <code>ToKVString</code>
| <code>string ToKVString()</code>
| 返回一个没有分隔符的字符串.
|}

==== Members ====
{| class="standard-table" style="width: 100%;"
! 实例
! 类型
! 描述
|-
| <code>x</code>
| <code>float</code>
| 笛卡尔x轴.
|-
| <code>y</code>
| <code>float</code>
| 笛卡尔y轴.
|-
| <code>z</code>
| <code>float</code>
| 笛卡尔z轴.
|}

== 全局函数 ==

=== 打印与绘制 ===

{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>DebugDrawBox</code>
| <code>void DebugDrawBox(vector ''origin'', vector ''min'', vector ''max'', int ''r'', int ''g'', int ''b'', int ''alpha'', float ''duration'')</code>
| 绘制一个调试覆盖框(debug overlay box).
|-
| <code>DebugDrawLine</code>
| <code>void DebugDrawLine(Vector ''start'', Vector ''end'', int ''red'', int ''green'', int ''blue', bool ''zTest'', float ''time'')</code>
| 在两点间绘制一根调试线(debug line).
|-
| <code>Msg</code>
| <code>void Msg(string ''message'')</code>
| 相当于<code>print</code>
|-
| <code>print</code>
| <code>void print(string ''message'')</code>
| 将给定的消息打印到开发人员控制台.
|-
| <code>printl</code>
| <code>void printl(string ''message'')</code>
| 功能同上, 但会在最后附加一个换行符.
|-
| <code>ScriptPrintMessageCenterAllWithParams</code>
| <code>void ScriptPrintMessageCenterAllWithParams(string, string, string, string)</code>
| 在屏幕中央向所有玩家打印消息. 需要传递token/消息. 可以传递null给param1, param2, param3如果你只需要3个以内的参数.
|-
| <code>ScriptPrintMessageCenterAll</code>
| <code>void ScriptPrintMessageCenterAll(string ''message'')</code>
| 在屏幕中央向所有玩家打印消息.
|-
| <code>ScriptPrintMessageCenterTeam</code>
| <code>void ScriptPrintMessageCenterTeam(int, string)</code>
| 在屏幕中央向指定队伍的玩家打印消息.
|-
| <code>ScriptPrintMessageChatAll</code>
| <code>void ScriptPrintMessageChatAll(string ''message'')</code>
| 在聊天框中向所有玩家打印消息.
|-
| <code>ScriptPrintMessageChatTeam</code>
| <code>void ScriptPrintMessageChatTeam(int ''teamNumber'', string ''message'')</code>
| 在聊天框中向指定队伍的玩家打印消息.
|-
| <code>ShowMessage</code>
| <code>void ShowMessage(string)</code>
| 打印一条HUD消息给所有玩家. {{Bug|不起作用}}
|-
| <code>__DumpScope</code>
| <code>void __DumpScope(int ''indentation'', handle ''scope'')</code>
| 转储域内的所有内容.
|-
|}

=== 训练课程相关 ===
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>ScriptGetBestTrainingCourseTime</code>
| <code>int ScriptGetBestTrainingCourseTime()</code>
| 获取玩家完成计时课程的最佳时间.
|-
| <code>ScriptGetPlayerCompletedTraining</code>
| <code>bool ScriptGetPlayerCompletedTraining()</code>
| 如果玩家已完成训练地图的初始部分, 则返回true.
|-
| <code>ScriptGetValveTrainingCourseTime</code>
| <code>int ScriptGetValveTrainingCourseTime()</code>
| 获得Valve完成计时课程的最佳时间。
|-
| <code>ScriptHighlightAmmoCounter</code>
| <code>void ScriptHighlightAmmoCounter()</code>
| 发送一个刚被指导系统用于显示一个用于突出弹药计数器的提示的事件.
|-
| <code>ScriptSetBestTrainingCourseTime</code>
| <code>void ScriptSetBestTrainingCourseTime(int ''bestTime'')</code>
| 设置玩家完成计时课程的最佳时间.
|-
| <code>ScriptSetMiniScoreHidden</code>
| <code>void ScriptSetMiniScoreHidden(bool ''scoreHidden'')</code>
| 切换迷你记分牌HUD元素的可见性.
|-
| <code>ScriptSetPlayerCompletedTraining</code>
| <code>void ScriptSetPlayerCompletedTraining(bool ''trainingCompleted'')</code>
| 设置玩家是否完成了训练地图的初始部分.
|-
| <code>ScriptShowExitDoorMsg</code>
| <code>void ScriptShowExitDoorMsg()</code>
| 当玩家通过出口门退出时, 在训练课程中显示一个消息框.
|-
| <code>ScriptShowFinishMsgBox</code>
| <code>void ScriptShowFinishMsgBox()</code>
| 显示一个消息框,让玩家在完成训练课程后知道下一步该怎么做.
|-
| <code>ScriptTrainingGivePlayerAmmo</code>
| <code>void ScriptTrainingGivePlayerAmmo()</code>
| 对玩家拥有的所有武器重新装填弹药（只在训练模式中有用）.
|-
|}

=== 合作模式相关 ===
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>ScriptCoopCollectBonusCoin</code>
| <code>void ScriptCoopCollectBonusCoin()</code>
| 将其中一个奖励币标记为已收集.
|-
| <code>ScriptCoopGiveC4sToCTs</code>
| <code>void ScriptCoopGiveC4sToCTs(int)</code>
| 将指定数量的C4给予所有活着的CT玩家.
|-
| <code>ScriptCoopMissionGetMissionNumber</code>
| <code>int ScriptCoopMissionGetMissionNumber()</code>
| 获取当前地图的任务编号（备注：地图可以有多个任务）.
|-
| <code>ScriptCoopMissionRespawnDeadPlayers</code>
| <code>void ScriptCoopMissionRespawnDeadPlayers()</code>
| 仅用于重生玩家.
|-
| <code>ScriptCoopMissionSetNextRespawnIn</code>
| <code>void ScriptCoopMissionSetNextRespawnIn(float, bool)</code>
| 设置下一波重生的发生时间.
|-
| <code>ScriptCoopMissionSpawnFirstEnemies</code>
| <code>void ScriptCoopMissionSpawnFirstEnemies(int)</code>
| 在合作模式中生成第一波敌人.
|-
| <code>ScriptCoopMissionSpawnNextWave</code>
| <code>void ScriptCoopMissionSpawnNextWave(int)</code>
| 告知合作模式中下一波将要出生的敌人. 此函数也会复活玩家.
|-
| <code>ScriptCoopResetRoundStartTime</code>
| <code>void ScriptCoopResetRoundStartTime()</code>
| 重设回合时间并开始任务.
|-
| <code>ScriptCoopSetBotQuotaAndRefreshSpawns</code>
| <code>void ScriptCoopSetBotQuotaAndRefreshSpawns(int)</code>
| 通过考量在线玩家数量来设置机器人数量并刷新复活.
|-
|}

=== 其他 ===
{| class="standard-table" style="width: 100%;"
! 函数
! 签名
! 描述
|-
| <code>Assert</code>
| <code>void Assert(bool ''value'', string ''optional message'')</code>
| 检测布尔值, 如果不是true, 则显示异常, 可附带消息.
|-
| <code>CreateProp</code>
| <code>handle CreateProp(string ''class'', Vector ''origin'', string ''model'', int ''animation'')</code>
| 通过指定的类型和模型创建一个prop. 对于prop_physics, prop_dynamic 和其他一些带模型的实体都有效. 这个函数不会预缓存模型. {{bug|不会初始化prop的物理属性.}}
|-
| <code>CreateSceneEntity</code>
| <code>CSceneEntity CreateSceneEntity(string ''scene'')</code>
| 创建一个场景实体来播放指定的场景.vcd文件.
|-
| <code>DispatchParticleEffect</code>
| <code>void DispatchParticleEffect(string particleName, Vector, Vector)</code>
| 调用一个一次性粒子系统.
|-
| <code>DoIncludeScript</code>
| <code>bool DoIncludeScript(string ''filename'', table ''scope'')</code>
| 执行脚本域设定为指定的表的脚本.
|-
| <code>DoEntFire</code>
| <code>void DoEntFire(string ''target'', string ''action'', string ''value'', float ''delay'', handle ''activator'', handle ''caller'')</code>
| 生成一个实体I/O事件. ''caller''参数为句柄, 所以 ''target'' 可以设置成''!self'' 来触发没有targetname的实体的输出.
|-
| <code>EntFire</code>
| <code>function EntFire(string ''target'', string ''action'', string ''value'', float ''delay'' = 0.0, handle ''activator'' = null)</code>
| 生成一个实体I/O事件.
|-
| <code>EntFireByHandle</code>
| <code>void EntFireByHandle(handle ''target'', string ''action'', string 'value'', float ''delay'', handle ''activator'', handle ''caller'')</code>
| 生成一个实体I/O事件. 第一个参数是一个实体实例, 所以无名的或者由脚本创建的实体的句柄可以被轻松地传递.
|-
| <code>FrameTime</code>
| <code>float FrameTime()</code>
| 获取上一帧在服务器上花费的时间.
|-
| <code>GetDeveloperLevel</code>
| <code>int GetDeveloperLevel()</code>
| 获取''developer''模式的级别.
|-
| <code>GetMapName</code>
| <code>string GetMapName()</code>
| 获取地图名.
|-
| <code>LoopSinglePlayerMaps</code>
| <code>bool LoopSinglePlayerMaps()</code>
| 连续循环运行单人游戏地图.
|-
| <code>PrintHelp</code>
|
| {{todo}}
|-
| <code>RandomFloat</code>
| <code>float RandomFloat()</code>
| 生成一个随机浮点数
|-
| <code>RandomFloat</code>
| <code>float RandomFloat(float ''min'', float ''max'')</code>
| 在一个给定范围内生成随机浮点数, 范围边界包括在内.
|-
| <code>RandomInt</code>
| <code>int RandomInt()</code>
| 生成一个随机整数.
|-
| <code>RandomInt</code>
| <code>int RandomInt(int ''min'', int ''max'')</code>
| 在一个给定范围内生成随机整数, 范围边界包括在内.
|-
| <code>RecordAchievementEvent</code>
| <code>void RecordAchievementEvent(string, int)</code>
| 录制成就事件或者进程.
|-
| <code>RetrieveNativeSignature</code>
| <code>void RetrieveNativeSignature(string ''or'' func)</code>
| 理论上这是用来打印本地函数的调用格式的函数, 但它实际上似乎只能输出 <code><unnamed></code>
|-
| <code>ScriptGetGameMode</code>
| <code>int ScriptGetGameMode()</code>
| 返回game_mode的设置. 请查阅 [[Counter-Strike:_Global_Offensive_Dedicated_Servers#Starting_the_Server|CSGODS # 建立服务器]] 了解更多信息.
|-
| <code>ScriptGetGameType</code>
| <code>int ScriptGetGameType()</code>
| 返回game_type的设置. 请查阅 [[Counter-Strike:_Global_Offensive_Dedicated_Servers#Starting_the_Server|CSGODS # 建立服务器]] 了解更多信息.
|-
| <code>ScriptGetRoundsPlayed</code>
| <code>int ScriptGetRoundsPlayed()</code>
| 获取从游戏开始迄今所经历的回合数.
|-
| <code>ScriptIsLocalPlayerUsingController</code>
| <code>bool ScriptIsLocalPlayerUsingController()</code>
| 返回玩家是否在使用控制器玩游戏.
|-
| <code>ScriptIsWarmupPeriod</code>
| <code>bool ScriptIsWarmupPeriod()</code>
| 返回是否是热身时间.
|-
| <code>ScriptSetRadarHidden</code>
| <code>void ScriptSetRadarHidden(bool ''hideRadar'')</code>
| 切换雷达HUD元素的可见性. 仅适用于训练模式（game_type 2且game_mode 0）并且仅适用于连接的第一个人.
|-
| <code>SendToConsole</code>
| <code>void SendToConsole(string ''command'')</code>
| 将一串命令以字符串形式发送到控制台.
|-
| <code>SendToConsoleServer</code>
| <code>void SendToConsoleServer(string)</code>
| 发送一个字符串, 作为服务器命令在服务器上执行.
|-
| <code>Time</code>
| <code>float Time()</code>
| 获取当前的服务器时间.
|-
| <code>TraceLine</code>
| <code>float TraceLine(Vector, Vector, handle)</code>
| given 2 points & ent to ignore, return fraction along line that hits world or models.
|-
| <code>UniqueString</code>
| <code>function UniqueString(string)</code>
| 使用可选的根字符串生成一个字符串, 该字符串在脚本VM的整个生命周期中保证是唯一的. 当不知道该表中已经使用了哪些密钥时,对于向表中添加数据来说作用很大.
|-
| <code>__ReplaceClosures</code>
|}

== 推荐阅读 ==
* [http://pastebin.com/7LRsSjEZ Pastebin with script that suggests it is run when Squirrel VM starts]

* [[List of L4D2 Script Functions]]
* {{portal2}} [[List of Portal 2 Script Functions]]

[[Category:Counter-Strike: Global Offensive]]
[[Category:Scripting]]