diff --git a/docs/classes/Angle/Add.md b/docs/classes/Angle/Add.md index 69f660943f..153948b14a 100644 --- a/docs/classes/Angle/Add.md +++ b/docs/classes/Angle/Add.md @@ -17,7 +17,7 @@ lua: - name: "angle2" type: Angle returns: - - type: angle + - type: Angle description: "The added angle." --- diff --git a/docs/classes/Angle/Divide.md b/docs/classes/Angle/Divide.md index 38f93d60ad..55e29b0d2a 100644 --- a/docs/classes/Angle/Divide.md +++ b/docs/classes/Angle/Divide.md @@ -17,7 +17,7 @@ lua: - name: "divideBy" type: number returns: - - type: angle + - type: Angle description: "The divided angle." --- diff --git a/docs/classes/Angle/Forward.md b/docs/classes/Angle/Forward.md index 830b430bee..9ed347770f 100644 --- a/docs/classes/Angle/Forward.md +++ b/docs/classes/Angle/Forward.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The forward vector of the angle." --- diff --git a/docs/classes/Angle/Init.md b/docs/classes/Angle/Init.md index 9961d56e95..ffbb5e4ab7 100644 --- a/docs/classes/Angle/Init.md +++ b/docs/classes/Angle/Init.md @@ -21,7 +21,7 @@ lua: - name: "z" type: number returns: - - type: angle + - type: Angle description: "The initialized angle." --- diff --git a/docs/classes/Angle/Invalidate.md b/docs/classes/Angle/Invalidate.md index b2052d57d2..8ef07331a1 100644 --- a/docs/classes/Angle/Invalidate.md +++ b/docs/classes/Angle/Invalidate.md @@ -15,7 +15,7 @@ lua: returns: - - type: angle + - type: Angle description: "The invalidated angle." --- diff --git a/docs/classes/Angle/Right.md b/docs/classes/Angle/Right.md index 4d71702f9e..9d248347c5 100644 --- a/docs/classes/Angle/Right.md +++ b/docs/classes/Angle/Right.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The right vector of the angle." --- diff --git a/docs/classes/Angle/RotateAroundAxis.md b/docs/classes/Angle/RotateAroundAxis.md index 99b9c63ccf..0954eff601 100644 --- a/docs/classes/Angle/RotateAroundAxis.md +++ b/docs/classes/Angle/RotateAroundAxis.md @@ -19,7 +19,7 @@ lua: - name: "degrees" type: number returns: - - type: angle + - type: Angle description: "The rotated angle." --- diff --git a/docs/classes/Angle/Scale.md b/docs/classes/Angle/Scale.md index 8410213ee1..42ff09e89e 100644 --- a/docs/classes/Angle/Scale.md +++ b/docs/classes/Angle/Scale.md @@ -17,7 +17,7 @@ lua: - name: "scaleBy" type: number returns: - - type: angle + - type: Angle description: "The scaled angle." --- diff --git a/docs/classes/Angle/Up.md b/docs/classes/Angle/Up.md index 1dab6d88e4..0fc95b4ca1 100644 --- a/docs/classes/Angle/Up.md +++ b/docs/classes/Angle/Up.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The up vector of the angle." --- diff --git a/docs/classes/Angle/__add.md b/docs/classes/Angle/__add.md index 44d4ac9357..3fb39125a6 100644 --- a/docs/classes/Angle/__add.md +++ b/docs/classes/Angle/__add.md @@ -17,7 +17,7 @@ lua: - name: "angle2" type: Angle returns: - - type: angle + - type: Angle description: "The added angle." --- diff --git a/docs/classes/Angle/__div.md b/docs/classes/Angle/__div.md index 595a87c882..3f76773817 100644 --- a/docs/classes/Angle/__div.md +++ b/docs/classes/Angle/__div.md @@ -17,7 +17,7 @@ lua: - name: "number" type: number returns: - - type: angle + - type: Angle description: "The divided angle." --- diff --git a/docs/classes/Angle/__mul.md b/docs/classes/Angle/__mul.md index 11c8fab583..eb7f0e111a 100644 --- a/docs/classes/Angle/__mul.md +++ b/docs/classes/Angle/__mul.md @@ -15,7 +15,7 @@ lua: returns: - - type: angle + - type: Angle description: "The multiplied angle." --- diff --git a/docs/classes/Angle/__sub.md b/docs/classes/Angle/__sub.md index 5b200087be..ef7f015a44 100644 --- a/docs/classes/Angle/__sub.md +++ b/docs/classes/Angle/__sub.md @@ -17,7 +17,7 @@ lua: - name: "angle2" type: Angle returns: - - type: angle + - type: Angle description: "The subtracted angle." --- diff --git a/docs/classes/Angle/__unm.md b/docs/classes/Angle/__unm.md index a8d7445d93..51aeaaaed3 100644 --- a/docs/classes/Angle/__unm.md +++ b/docs/classes/Angle/__unm.md @@ -15,7 +15,7 @@ lua: returns: - - type: angle + - type: Angle description: "The negated angle." --- diff --git a/docs/classes/EffectData/GetEntity.md b/docs/classes/EffectData/GetEntity.md index 970c0f484e..aa8220ebe5 100644 --- a/docs/classes/EffectData/GetEntity.md +++ b/docs/classes/EffectData/GetEntity.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "Entity." --- diff --git a/docs/classes/Entity/BecomeRagdollOnClient.md b/docs/classes/Entity/BecomeRagdollOnClient.md index ad59e7ce72..e6969a708a 100644 --- a/docs/classes/Entity/BecomeRagdollOnClient.md +++ b/docs/classes/Entity/BecomeRagdollOnClient.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The ragdoll entity" --- diff --git a/docs/classes/Entity/BodyTarget.md b/docs/classes/Entity/BodyTarget.md index fe0b22463a..b6d54d2c43 100644 --- a/docs/classes/Entity/BodyTarget.md +++ b/docs/classes/Entity/BodyTarget.md @@ -20,7 +20,7 @@ lua: type: boolean default: "true" returns: - - type: vector + - type: Vector description: "The body target" --- diff --git a/docs/classes/Entity/CalculateNearestPoint.md b/docs/classes/Entity/CalculateNearestPoint.md index 1515dd778c..cc5d0ea091 100644 --- a/docs/classes/Entity/CalculateNearestPoint.md +++ b/docs/classes/Entity/CalculateNearestPoint.md @@ -17,7 +17,7 @@ lua: - name: "point" type: Vector returns: - - type: vector + - type: Vector description: "The nearest point." --- diff --git a/docs/classes/Entity/ComputeAbsoluteDirection.md b/docs/classes/Entity/ComputeAbsoluteDirection.md index 191d989245..6ab3fcadd7 100644 --- a/docs/classes/Entity/ComputeAbsoluteDirection.md +++ b/docs/classes/Entity/ComputeAbsoluteDirection.md @@ -17,7 +17,7 @@ lua: - name: "localDir" type: Vector returns: - - type: vector + - type: Vector description: "The absolute direction." --- diff --git a/docs/classes/Entity/ComputeAbsolutePosition.md b/docs/classes/Entity/ComputeAbsolutePosition.md index b407c4a4f3..5e6d5e3020 100644 --- a/docs/classes/Entity/ComputeAbsolutePosition.md +++ b/docs/classes/Entity/ComputeAbsolutePosition.md @@ -17,7 +17,7 @@ lua: - name: "localPos" type: Vector returns: - - type: vector + - type: Vector description: "The absolute position." --- diff --git a/docs/classes/Entity/ComputeWorldSpaceSurroundingBox.md b/docs/classes/Entity/ComputeWorldSpaceSurroundingBox.md index 8a37b97aa3..cc55f181f7 100644 --- a/docs/classes/Entity/ComputeWorldSpaceSurroundingBox.md +++ b/docs/classes/Entity/ComputeWorldSpaceSurroundingBox.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The minimum vector." - type: vector description: "The maximum vector." diff --git a/docs/classes/Entity/CreatePredictedEntityByName.md b/docs/classes/Entity/CreatePredictedEntityByName.md index 7eb55ca19b..5930607463 100644 --- a/docs/classes/Entity/CreatePredictedEntityByName.md +++ b/docs/classes/Entity/CreatePredictedEntityByName.md @@ -24,7 +24,7 @@ lua: type: boolean default: "false" returns: - - type: entity + - type: Entity description: "The predicted entity." --- diff --git a/docs/classes/Entity/CreateRagdollCopy.md b/docs/classes/Entity/CreateRagdollCopy.md index aab97e8eae..97202c57c5 100644 --- a/docs/classes/Entity/CreateRagdollCopy.md +++ b/docs/classes/Entity/CreateRagdollCopy.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The ragdoll entity" --- diff --git a/docs/classes/Entity/DropToFloor.md b/docs/classes/Entity/DropToFloor.md new file mode 100644 index 0000000000..34db816ba9 --- /dev/null +++ b/docs/classes/Entity/DropToFloor.md @@ -0,0 +1,30 @@ +--- +template: lua-class-function.html +title: DropToFloor +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entity + function: DropToFloor + realm: server + description: "Drops the entity to the floor." + + arguments: + - name: "mask" + type: integer + default: "MASK_SOLID" + - name: "ignore" + type: Entity + default: "NULL" + returns: + - type: number + description: "-1 if the floor to drop to isn't valid. 0 if nothing changed. 1 if the entity dropped to the floor" +--- + +
+Entity:DropToFloor – Drops the entity to the floor. +
diff --git a/docs/classes/Entity/EntityToWorldSpace.md b/docs/classes/Entity/EntityToWorldSpace.md index 94ded601cd..1f4ec91237 100644 --- a/docs/classes/Entity/EntityToWorldSpace.md +++ b/docs/classes/Entity/EntityToWorldSpace.md @@ -17,7 +17,7 @@ lua: - name: "local" type: Vector returns: - - type: vector + - type: Vector description: "The world space vector." --- diff --git a/docs/classes/Entity/FindFollowedEntity.md b/docs/classes/Entity/FindFollowedEntity.md index 89a71da110..3cee796d45 100644 --- a/docs/classes/Entity/FindFollowedEntity.md +++ b/docs/classes/Entity/FindFollowedEntity.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The followed entity" --- diff --git a/docs/classes/Entity/GetAimEntOrigin.md b/docs/classes/Entity/GetAimEntOrigin.md index 97c77246a2..b71ee25651 100644 --- a/docs/classes/Entity/GetAimEntOrigin.md +++ b/docs/classes/Entity/GetAimEntOrigin.md @@ -17,7 +17,7 @@ lua: - name: "attachedTo" type: Entity returns: - - type: vector + - type: Vector description: "The aim entity origin" - type: angle description: "The aim entity angles" diff --git a/docs/classes/Entity/GetAngles.md b/docs/classes/Entity/GetAngles.md index 418b2a56cc..59d239bdf2 100644 --- a/docs/classes/Entity/GetAngles.md +++ b/docs/classes/Entity/GetAngles.md @@ -15,7 +15,7 @@ lua: returns: - - type: angle + - type: Angle description: "The absolute angles." --- diff --git a/docs/classes/Entity/GetAutoAimCenter.md b/docs/classes/Entity/GetAutoAimCenter.md index ea8a3156dd..7de6f262d5 100644 --- a/docs/classes/Entity/GetAutoAimCenter.md +++ b/docs/classes/Entity/GetAutoAimCenter.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The auto aim center" --- diff --git a/docs/classes/Entity/GetBaseVelocity.md b/docs/classes/Entity/GetBaseVelocity.md index 931fb2dd9f..fb80445bc5 100644 --- a/docs/classes/Entity/GetBaseVelocity.md +++ b/docs/classes/Entity/GetBaseVelocity.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The base velocity." --- diff --git a/docs/classes/Entity/GetBlendedLinearVelocity.md b/docs/classes/Entity/GetBlendedLinearVelocity.md index 5922382b3c..7f9bc321c7 100644 --- a/docs/classes/Entity/GetBlendedLinearVelocity.md +++ b/docs/classes/Entity/GetBlendedLinearVelocity.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The blended linear velocity" --- diff --git a/docs/classes/Entity/GetBonePosition.md b/docs/classes/Entity/GetBonePosition.md index ff3fbaa1b0..6be90b7bc7 100644 --- a/docs/classes/Entity/GetBonePosition.md +++ b/docs/classes/Entity/GetBonePosition.md @@ -17,7 +17,7 @@ lua: - name: "bone" type: number returns: - - type: vector + - type: Vector description: "The origin" - type: angle description: "The angles" diff --git a/docs/classes/Entity/GetEarPosition.md b/docs/classes/Entity/GetEarPosition.md index 55938453da..f0f2a16147 100644 --- a/docs/classes/Entity/GetEarPosition.md +++ b/docs/classes/Entity/GetEarPosition.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The ear position." --- diff --git a/docs/classes/Entity/GetEffectEntity.md b/docs/classes/Entity/GetEffectEntity.md index 57c066c87b..b5cc0fb846 100644 --- a/docs/classes/Entity/GetEffectEntity.md +++ b/docs/classes/Entity/GetEffectEntity.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The effect entity." --- diff --git a/docs/classes/Entity/GetEnemy.md b/docs/classes/Entity/GetEnemy.md index d8b8c0f8dd..8a6be564d1 100644 --- a/docs/classes/Entity/GetEnemy.md +++ b/docs/classes/Entity/GetEnemy.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The enemy" --- diff --git a/docs/classes/Entity/GetEyeAngles.md b/docs/classes/Entity/GetEyeAngles.md index 25dc4b7afd..1fef59c71f 100644 --- a/docs/classes/Entity/GetEyeAngles.md +++ b/docs/classes/Entity/GetEyeAngles.md @@ -15,7 +15,7 @@ lua: returns: - - type: angle + - type: Angle description: "The eye angles." --- diff --git a/docs/classes/Entity/GetEyePosition.md b/docs/classes/Entity/GetEyePosition.md index b9dd32aa11..4484dffed0 100644 --- a/docs/classes/Entity/GetEyePosition.md +++ b/docs/classes/Entity/GetEyePosition.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The eye position." --- diff --git a/docs/classes/Entity/GetFirstMoveChild.md b/docs/classes/Entity/GetFirstMoveChild.md index c979c685bd..b8263effb1 100644 --- a/docs/classes/Entity/GetFirstMoveChild.md +++ b/docs/classes/Entity/GetFirstMoveChild.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The first move child." --- diff --git a/docs/classes/Entity/GetFollowedEntity.md b/docs/classes/Entity/GetFollowedEntity.md index 064d017bc1..ef0b1cd1ee 100644 --- a/docs/classes/Entity/GetFollowedEntity.md +++ b/docs/classes/Entity/GetFollowedEntity.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The followed entity." --- diff --git a/docs/classes/Entity/GetGroundEntity.md b/docs/classes/Entity/GetGroundEntity.md index b52dd36f4d..08d500a721 100644 --- a/docs/classes/Entity/GetGroundEntity.md +++ b/docs/classes/Entity/GetGroundEntity.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The ground entity." --- diff --git a/docs/classes/Entity/GetGroundVelocityToApply.md b/docs/classes/Entity/GetGroundVelocityToApply.md index df9ea6d2b3..ee33c95b96 100644 --- a/docs/classes/Entity/GetGroundVelocityToApply.md +++ b/docs/classes/Entity/GetGroundVelocityToApply.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The ground velocity to apply" --- diff --git a/docs/classes/Entity/GetLocalAngles.md b/docs/classes/Entity/GetLocalAngles.md index 93dc4c107f..5f825286b4 100644 --- a/docs/classes/Entity/GetLocalAngles.md +++ b/docs/classes/Entity/GetLocalAngles.md @@ -15,7 +15,7 @@ lua: returns: - - type: angle + - type: Angle description: "The local angles." --- diff --git a/docs/classes/Entity/GetLocalAngularVelocity.md b/docs/classes/Entity/GetLocalAngularVelocity.md index 79ad117d90..b84b8b23d9 100644 --- a/docs/classes/Entity/GetLocalAngularVelocity.md +++ b/docs/classes/Entity/GetLocalAngularVelocity.md @@ -15,7 +15,7 @@ lua: returns: - - type: angle + - type: Angle description: "The local angular velocity." --- diff --git a/docs/classes/Entity/GetLocalOrigin.md b/docs/classes/Entity/GetLocalOrigin.md index f95f7a46fb..22e534f42d 100644 --- a/docs/classes/Entity/GetLocalOrigin.md +++ b/docs/classes/Entity/GetLocalOrigin.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The local origin." --- diff --git a/docs/classes/Entity/GetLocalVelocity.md b/docs/classes/Entity/GetLocalVelocity.md index ceb61b74b1..6608b542d6 100644 --- a/docs/classes/Entity/GetLocalVelocity.md +++ b/docs/classes/Entity/GetLocalVelocity.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The local velocity." --- diff --git a/docs/classes/Entity/GetModelBounds.md b/docs/classes/Entity/GetModelBounds.md index 35e0a33b56..86c7a5941d 100644 --- a/docs/classes/Entity/GetModelBounds.md +++ b/docs/classes/Entity/GetModelBounds.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The minimum bounds." - type: vector description: "The maximum bounds." diff --git a/docs/classes/Entity/GetMoveParent.md b/docs/classes/Entity/GetMoveParent.md index 55afc06852..686e5e1960 100644 --- a/docs/classes/Entity/GetMoveParent.md +++ b/docs/classes/Entity/GetMoveParent.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The move parent." --- diff --git a/docs/classes/Entity/GetNextTarget.md b/docs/classes/Entity/GetNextTarget.md index 7a12e492df..c1cbff1a27 100644 --- a/docs/classes/Entity/GetNextTarget.md +++ b/docs/classes/Entity/GetNextTarget.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The next target" --- diff --git a/docs/classes/Entity/GetOBBCenter.md b/docs/classes/Entity/GetOBBCenter.md index d924a98a94..9e4d40b7e1 100644 --- a/docs/classes/Entity/GetOBBCenter.md +++ b/docs/classes/Entity/GetOBBCenter.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The OBB center." --- diff --git a/docs/classes/Entity/GetOBBMaxs.md b/docs/classes/Entity/GetOBBMaxs.md index 82cb1d374c..0d94d834e1 100644 --- a/docs/classes/Entity/GetOBBMaxs.md +++ b/docs/classes/Entity/GetOBBMaxs.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The OBB maxs." --- diff --git a/docs/classes/Entity/GetOBBMins.md b/docs/classes/Entity/GetOBBMins.md index b3cb90102c..a5e3413aaa 100644 --- a/docs/classes/Entity/GetOBBMins.md +++ b/docs/classes/Entity/GetOBBMins.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The OBB mins." --- diff --git a/docs/classes/Entity/GetObserverCameraOrigin.md b/docs/classes/Entity/GetObserverCameraOrigin.md index 850ddad831..7895486613 100644 --- a/docs/classes/Entity/GetObserverCameraOrigin.md +++ b/docs/classes/Entity/GetObserverCameraOrigin.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "Observer camera origin." --- diff --git a/docs/classes/Entity/GetOwnerEntity.md b/docs/classes/Entity/GetOwnerEntity.md index 03c01bc664..2c3c6423ea 100644 --- a/docs/classes/Entity/GetOwnerEntity.md +++ b/docs/classes/Entity/GetOwnerEntity.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The owner entity." --- diff --git a/docs/classes/Entity/GetPosition.md b/docs/classes/Entity/GetPosition.md index cf521190da..89f32f3a6c 100644 --- a/docs/classes/Entity/GetPosition.md +++ b/docs/classes/Entity/GetPosition.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The absolute origin." --- diff --git a/docs/classes/Entity/GetPredictedPosition.md b/docs/classes/Entity/GetPredictedPosition.md new file mode 100644 index 0000000000..3063809c3d --- /dev/null +++ b/docs/classes/Entity/GetPredictedPosition.md @@ -0,0 +1,26 @@ +--- +template: lua-class-function.html +title: GetPredictedPosition +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entity + function: GetPredictedPosition + realm: server + description: "Get the predicted postion of an entity of a certain number of seconds. Use this function with caution, it has great potential for annoying the player, especially if used for target firing predition" + + arguments: + - name: "timeDelta" + type: number + returns: + - type: Vector + description: "The predicted position of the entity" +--- + +
+Entity:GetPredictedPosition – Get the predicted postion of an entity of a certain number of seconds. Use this function with caution, it has great potential for annoying the player, especially if used for target firing predition +
diff --git a/docs/classes/Entity/GetPredictionPlayer.md b/docs/classes/Entity/GetPredictionPlayer.md index 67baa04775..1766c68569 100644 --- a/docs/classes/Entity/GetPredictionPlayer.md +++ b/docs/classes/Entity/GetPredictionPlayer.md @@ -16,7 +16,7 @@ lua: static: true returns: - - type: entity + - type: Entity description: "The prediction player." --- diff --git a/docs/classes/Entity/GetRenderAngles.md b/docs/classes/Entity/GetRenderAngles.md index 9c78e983ef..8ed4ca79b3 100644 --- a/docs/classes/Entity/GetRenderAngles.md +++ b/docs/classes/Entity/GetRenderAngles.md @@ -15,7 +15,7 @@ lua: returns: - - type: angle + - type: Angle description: "Render angles." --- diff --git a/docs/classes/Entity/GetRenderBounds.md b/docs/classes/Entity/GetRenderBounds.md index 45c7a2ffb5..795d9b0f8d 100644 --- a/docs/classes/Entity/GetRenderBounds.md +++ b/docs/classes/Entity/GetRenderBounds.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The minimum bounds" - type: vector description: "The maximum bounds" diff --git a/docs/classes/Entity/GetRenderOrigin.md b/docs/classes/Entity/GetRenderOrigin.md index 00c2aa6251..5759835bc9 100644 --- a/docs/classes/Entity/GetRenderOrigin.md +++ b/docs/classes/Entity/GetRenderOrigin.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "Render origin." --- diff --git a/docs/classes/Entity/GetSequenceLinearMotion.md b/docs/classes/Entity/GetSequenceLinearMotion.md index 5162bc00d9..1aa0763ad0 100644 --- a/docs/classes/Entity/GetSequenceLinearMotion.md +++ b/docs/classes/Entity/GetSequenceLinearMotion.md @@ -17,7 +17,7 @@ lua: - name: "sequence" type: number returns: - - type: vector + - type: Vector description: "The sequence linear motion" --- diff --git a/docs/classes/Entity/GetSimulatingPlayer.md b/docs/classes/Entity/GetSimulatingPlayer.md index 05072e18a2..238ba7813a 100644 --- a/docs/classes/Entity/GetSimulatingPlayer.md +++ b/docs/classes/Entity/GetSimulatingPlayer.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The simulating player." --- diff --git a/docs/classes/Entity/GetSmoothedVelocity.md b/docs/classes/Entity/GetSmoothedVelocity.md index 500dcd8025..6a42229f63 100644 --- a/docs/classes/Entity/GetSmoothedVelocity.md +++ b/docs/classes/Entity/GetSmoothedVelocity.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The smoothed velocity" --- diff --git a/docs/classes/Entity/GetSoundEmissionOrigin.md b/docs/classes/Entity/GetSoundEmissionOrigin.md index 7aebfa8ef0..4f64fdc864 100644 --- a/docs/classes/Entity/GetSoundEmissionOrigin.md +++ b/docs/classes/Entity/GetSoundEmissionOrigin.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The sound emission origin" --- diff --git a/docs/classes/Entity/GetVectors.md b/docs/classes/Entity/GetVectors.md index 5530ca4b17..e01560d9d9 100644 --- a/docs/classes/Entity/GetVectors.md +++ b/docs/classes/Entity/GetVectors.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The forward vector." - type: vector description: "The right vector." diff --git a/docs/classes/Entity/GetVelocity.md b/docs/classes/Entity/GetVelocity.md index 217b7a7124..81e12ac75f 100644 --- a/docs/classes/Entity/GetVelocity.md +++ b/docs/classes/Entity/GetVelocity.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The absolute velocity." --- diff --git a/docs/classes/Entity/GetViewOffset.md b/docs/classes/Entity/GetViewOffset.md index d775531072..d4595e56d3 100644 --- a/docs/classes/Entity/GetViewOffset.md +++ b/docs/classes/Entity/GetViewOffset.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The view offset." --- diff --git a/docs/classes/Entity/GetWaterLevel.md b/docs/classes/Entity/GetWaterLevel.md index bb2c5c6ea2..57fe50875a 100644 --- a/docs/classes/Entity/GetWaterLevel.md +++ b/docs/classes/Entity/GetWaterLevel.md @@ -11,7 +11,7 @@ lua: library: Entity function: GetWaterLevel realm: shared - description: "Get water level." + description: "Get water level enum." returns: @@ -20,5 +20,5 @@ lua: ---
-Entity:GetWaterLevel – Get water level. +Entity:GetWaterLevel – Get water level enum.
diff --git a/docs/classes/Entity/HasMatchingRootParent.md b/docs/classes/Entity/HasMatchingRootParent.md new file mode 100644 index 0000000000..3af6ebcbd8 --- /dev/null +++ b/docs/classes/Entity/HasMatchingRootParent.md @@ -0,0 +1,26 @@ +--- +template: lua-class-function.html +title: HasMatchingRootParent +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Entity + function: HasMatchingRootParent + realm: shared + description: "Checks if the given entity has a matching root parent." + + arguments: + - name: "other" + type: Entity + returns: + - type: boolean + description: "The given entity has a matching root parent with this entity." +--- + +
+Entity:HasMatchingRootParent – Checks if the given entity has a matching root parent. +
diff --git a/docs/classes/Entity/HeadTarget.md b/docs/classes/Entity/HeadTarget.md index 81fdc1e25c..0d11f62830 100644 --- a/docs/classes/Entity/HeadTarget.md +++ b/docs/classes/Entity/HeadTarget.md @@ -17,7 +17,7 @@ lua: - name: "position" type: Vector returns: - - type: vector + - type: Vector description: "The head target" --- diff --git a/docs/classes/Entity/Instance.md b/docs/classes/Entity/Instance.md index 68f80534f7..d7222b07c3 100644 --- a/docs/classes/Entity/Instance.md +++ b/docs/classes/Entity/Instance.md @@ -18,7 +18,7 @@ lua: - name: "edictIndex" type: integer returns: - - type: entity + - type: Entity description: "The entity instance" --- diff --git a/docs/classes/Entity/IsInSolid.md b/docs/classes/Entity/IsInSolid.md new file mode 100644 index 0000000000..7796b625b7 --- /dev/null +++ b/docs/classes/Entity/IsInSolid.md @@ -0,0 +1,24 @@ +--- +template: lua-class-function.html +title: IsInSolid +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entity + function: IsInSolid + realm: server + description: "Is in solid." + + + returns: + - type: boolean + description: "true if in solid, false otherwise." +--- + +
+Entity:IsInSolid – Is in solid. +
diff --git a/docs/classes/Entity/IsWorld.md b/docs/classes/Entity/IsWorld.md index c2460bca89..16e812a4cf 100644 --- a/docs/classes/Entity/IsWorld.md +++ b/docs/classes/Entity/IsWorld.md @@ -1,16 +1,16 @@ --- template: lua-class-function.html title: IsWorld -icon: lua-server +icon: lua-shared tags: - lua - - server + - shared - needs-verification - needs-example lua: library: Entity function: IsWorld - realm: server + realm: shared description: "Whether entity is world." diff --git a/docs/classes/Entity/LocalEyeAngles.md b/docs/classes/Entity/LocalEyeAngles.md index 2bea7283f1..9f91dac55e 100644 --- a/docs/classes/Entity/LocalEyeAngles.md +++ b/docs/classes/Entity/LocalEyeAngles.md @@ -15,7 +15,7 @@ lua: returns: - - type: angle + - type: Angle description: "The local eye angles." --- diff --git a/docs/classes/Entity/NextMovePeer.md b/docs/classes/Entity/NextMovePeer.md index a1950df692..88b4a9c0cc 100644 --- a/docs/classes/Entity/NextMovePeer.md +++ b/docs/classes/Entity/NextMovePeer.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The next move peer." --- diff --git a/docs/classes/Entity/PointAtEntity.md b/docs/classes/Entity/PointAtEntity.md new file mode 100644 index 0000000000..1b9b095f95 --- /dev/null +++ b/docs/classes/Entity/PointAtEntity.md @@ -0,0 +1,26 @@ +--- +template: lua-class-function.html +title: PointAtEntity +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entity + function: PointAtEntity + realm: server + description: "Point at the specified entity" + + arguments: + - name: "target" + type: Entity + returns: + - type: boolean + description: "true if pointed at, false if one of the entities was invalid." +--- + +
+Entity:PointAtEntity – Point at the specified entity +
diff --git a/docs/classes/Entity/Respawn.md b/docs/classes/Entity/Respawn.md index 78bf0246a5..d2a5ab38ba 100644 --- a/docs/classes/Entity/Respawn.md +++ b/docs/classes/Entity/Respawn.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The respawned entity" --- diff --git a/docs/classes/Entity/ScreenShake.md b/docs/classes/Entity/ScreenShake.md new file mode 100644 index 0000000000..b0f8217976 --- /dev/null +++ b/docs/classes/Entity/ScreenShake.md @@ -0,0 +1,39 @@ +--- +template: lua-class-function.html +title: ScreenShake +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entity + function: ScreenShake + realm: server + description: "Shake an object and all players on or near it." + + arguments: + - name: "center" + type: Vector + - name: "amplitude" + type: number + - name: "frequency" + type: number + - name: "duration" + type: number + - name: "radius" + type: number + - name: "shakeCommand" + type: number + default: "SHAKE_START" + - name: "shouldShakePlayersInAir" + type: boolean + default: "false" + returns: + +--- + +
+Entity:ScreenShake – Shake an object and all players on or near it. +
diff --git a/docs/classes/Entity/SetWaterLevel.md b/docs/classes/Entity/SetWaterLevel.md index ddcc55c0f7..8d1a62360a 100644 --- a/docs/classes/Entity/SetWaterLevel.md +++ b/docs/classes/Entity/SetWaterLevel.md @@ -11,7 +11,7 @@ lua: library: Entity function: SetWaterLevel realm: shared - description: "Set water level." + description: "Set water level enum." arguments: - name: "level" @@ -21,5 +21,5 @@ lua: ---
-Entity:SetWaterLevel – Set water level. +Entity:SetWaterLevel – Set water level enum.
diff --git a/docs/classes/Entity/TransferPoseParameters.md b/docs/classes/Entity/TransferPoseParameters.md new file mode 100644 index 0000000000..523746cd39 --- /dev/null +++ b/docs/classes/Entity/TransferPoseParameters.md @@ -0,0 +1,26 @@ +--- +template: lua-class-function.html +title: TransferPoseParameters +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entity + function: TransferPoseParameters + realm: server + description: "Transfer pose parameters from one entity to another" + + arguments: + - name: "target" + type: Entity + returns: + - type: boolean + description: "true if transfered, false if one of the entities wasn't valid." +--- + +
+Entity:TransferPoseParameters – Transfer pose parameters from one entity to another +
diff --git a/docs/classes/Entity/UncorrectViewModelAttachment.md b/docs/classes/Entity/UncorrectViewModelAttachment.md index f6bd14f6f5..6145418075 100644 --- a/docs/classes/Entity/UncorrectViewModelAttachment.md +++ b/docs/classes/Entity/UncorrectViewModelAttachment.md @@ -17,7 +17,7 @@ lua: - name: "origin" type: Vector returns: - - type: vector + - type: Vector description: "The uncorrected view model attachment origin" --- diff --git a/docs/classes/Material/GetReflectivity.md b/docs/classes/Material/GetReflectivity.md index b0e69fa5d3..ef40ff70b5 100644 --- a/docs/classes/Material/GetReflectivity.md +++ b/docs/classes/Material/GetReflectivity.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "Reflectivity." --- diff --git a/docs/classes/Material/GetVector.md b/docs/classes/Material/GetVector.md index e1cec06207..5cd20bbf08 100644 --- a/docs/classes/Material/GetVector.md +++ b/docs/classes/Material/GetVector.md @@ -17,7 +17,7 @@ lua: - name: "varName" type: string returns: - - type: vector + - type: Vector description: "Vector value." --- diff --git a/docs/classes/Matrix/ApplyRotation.md b/docs/classes/Matrix/ApplyRotation.md index f39f45a937..1f11be4572 100644 --- a/docs/classes/Matrix/ApplyRotation.md +++ b/docs/classes/Matrix/ApplyRotation.md @@ -17,7 +17,7 @@ lua: - name: "vector" type: Vector returns: - - type: vector + - type: Vector description: "The rotated vector." --- diff --git a/docs/classes/Matrix/GetBasisVectors.md b/docs/classes/Matrix/GetBasisVectors.md index 30633effa2..9528b27aef 100644 --- a/docs/classes/Matrix/GetBasisVectors.md +++ b/docs/classes/Matrix/GetBasisVectors.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The forward vector." - type: vector description: "The left vector." diff --git a/docs/classes/Matrix/GetForward.md b/docs/classes/Matrix/GetForward.md index 629029cc4f..f3d1d06fa5 100644 --- a/docs/classes/Matrix/GetForward.md +++ b/docs/classes/Matrix/GetForward.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The forward vector." --- diff --git a/docs/classes/Matrix/GetLeft.md b/docs/classes/Matrix/GetLeft.md index 2720494d05..acf0665fd0 100644 --- a/docs/classes/Matrix/GetLeft.md +++ b/docs/classes/Matrix/GetLeft.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The left vector." --- diff --git a/docs/classes/Matrix/GetScale.md b/docs/classes/Matrix/GetScale.md index 2f0ed9fd92..49e6014341 100644 --- a/docs/classes/Matrix/GetScale.md +++ b/docs/classes/Matrix/GetScale.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The scale." --- diff --git a/docs/classes/Matrix/GetTranslation.md b/docs/classes/Matrix/GetTranslation.md index d38e90cefa..4a81086983 100644 --- a/docs/classes/Matrix/GetTranslation.md +++ b/docs/classes/Matrix/GetTranslation.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The translation." --- diff --git a/docs/classes/Matrix/GetUp.md b/docs/classes/Matrix/GetUp.md index 10e8c44fa8..058669256f 100644 --- a/docs/classes/Matrix/GetUp.md +++ b/docs/classes/Matrix/GetUp.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The up vector." --- diff --git a/docs/classes/Matrix/MultiplyByVector3x3.md b/docs/classes/Matrix/MultiplyByVector3x3.md index fa49e0eab6..d0044ce295 100644 --- a/docs/classes/Matrix/MultiplyByVector3x3.md +++ b/docs/classes/Matrix/MultiplyByVector3x3.md @@ -17,7 +17,7 @@ lua: - name: "vector" type: Vector returns: - - type: vector + - type: Vector description: "The multiplied vector." --- diff --git a/docs/classes/Matrix/MultiplyByVector4x3.md b/docs/classes/Matrix/MultiplyByVector4x3.md index 863aebb05d..c02da4078b 100644 --- a/docs/classes/Matrix/MultiplyByVector4x3.md +++ b/docs/classes/Matrix/MultiplyByVector4x3.md @@ -17,7 +17,7 @@ lua: - name: "vector" type: Vector returns: - - type: vector + - type: Vector description: "The multiplied vector." --- diff --git a/docs/classes/Matrix/MultiplyByVectorTranspose3x3.md b/docs/classes/Matrix/MultiplyByVectorTranspose3x3.md index 8a6a4917a6..7badbc1d28 100644 --- a/docs/classes/Matrix/MultiplyByVectorTranspose3x3.md +++ b/docs/classes/Matrix/MultiplyByVectorTranspose3x3.md @@ -17,7 +17,7 @@ lua: - name: "vector" type: Vector returns: - - type: vector + - type: Vector description: "The multiplied vector." --- diff --git a/docs/classes/Matrix/MultiplyByVectorTranspose4x3.md b/docs/classes/Matrix/MultiplyByVectorTranspose4x3.md index 291598629a..b72c39e55a 100644 --- a/docs/classes/Matrix/MultiplyByVectorTranspose4x3.md +++ b/docs/classes/Matrix/MultiplyByVectorTranspose4x3.md @@ -17,7 +17,7 @@ lua: - name: "vector" type: Vector returns: - - type: vector + - type: Vector description: "The multiplied vector." --- diff --git a/docs/classes/Player/BecomeRagdollOnClient.client.md b/docs/classes/Player/BecomeRagdollOnClient.client.md index 5c92d71f55..5c4ec495b0 100644 --- a/docs/classes/Player/BecomeRagdollOnClient.client.md +++ b/docs/classes/Player/BecomeRagdollOnClient.client.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The ragdoll entity" --- diff --git a/docs/classes/Player/ClampPunchAngleOffset.md b/docs/classes/Player/ClampPunchAngleOffset.md new file mode 100644 index 0000000000..1b95327f81 --- /dev/null +++ b/docs/classes/Player/ClampPunchAngleOffset.md @@ -0,0 +1,27 @@ +--- +template: lua-class-function.html +title: ClampPunchAngleOffset +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Player + function: ClampPunchAngleOffset + realm: server + description: "Adds angleToClamp with the player's punch angle and clamps it between -clampTo and clampTo." + + arguments: + - name: "start" + type: Angle + - name: "clampTo" + type: Angle + returns: + +--- + +
+Player:ClampPunchAngleOffset – Adds angleToClamp with the player's punch angle and clamps it between -clampTo and clampTo. +
diff --git a/docs/classes/Player/FindUseEntity.md b/docs/classes/Player/FindUseEntity.md index 53d8c92317..67dde309e9 100644 --- a/docs/classes/Player/FindUseEntity.md +++ b/docs/classes/Player/FindUseEntity.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The entity the player is using." --- diff --git a/docs/classes/Player/GetBodyAngles.md b/docs/classes/Player/GetBodyAngles.md index f65c919756..5fd3c34c62 100644 --- a/docs/classes/Player/GetBodyAngles.md +++ b/docs/classes/Player/GetBodyAngles.md @@ -15,7 +15,7 @@ lua: returns: - - type: angle + - type: Angle description: "The body angles." --- diff --git a/docs/classes/Player/GetBodyTarget.md b/docs/classes/Player/GetBodyTarget.md index 0a92002f6e..cda7b81231 100644 --- a/docs/classes/Player/GetBodyTarget.md +++ b/docs/classes/Player/GetBodyTarget.md @@ -17,7 +17,7 @@ lua: - name: "target" type: Vector returns: - - type: vector + - type: Vector description: "The body target." --- diff --git a/docs/classes/Player/GetHands.md b/docs/classes/Player/GetHands.md index 1b6784fa22..95d33cf85e 100644 --- a/docs/classes/Player/GetHands.md +++ b/docs/classes/Player/GetHands.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The player's hands." --- diff --git a/docs/classes/Player/GetObserverTarget.md b/docs/classes/Player/GetObserverTarget.md index aa4bb5cf68..341ae1b906 100644 --- a/docs/classes/Player/GetObserverTarget.md +++ b/docs/classes/Player/GetObserverTarget.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The player's observer target." --- diff --git a/docs/classes/Player/GetUseEntity.md b/docs/classes/Player/GetUseEntity.md index 8af321948c..856bf4a094 100644 --- a/docs/classes/Player/GetUseEntity.md +++ b/docs/classes/Player/GetUseEntity.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The player's use entity." --- diff --git a/docs/classes/Player/GetVehicleEntity.md b/docs/classes/Player/GetVehicleEntity.md index f114079e0b..c9d84dfa88 100644 --- a/docs/classes/Player/GetVehicleEntity.md +++ b/docs/classes/Player/GetVehicleEntity.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The player's vehicle entity." --- diff --git a/docs/classes/Player/GetViewEntity.md b/docs/classes/Player/GetViewEntity.md index 5b5d0599e7..c0ac180869 100644 --- a/docs/classes/Player/GetViewEntity.md +++ b/docs/classes/Player/GetViewEntity.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "The player's view entity." --- diff --git a/docs/classes/Player/GetViewModel.md b/docs/classes/Player/GetViewModel.md index 5543bdb47b..9912570dd3 100644 --- a/docs/classes/Player/GetViewModel.md +++ b/docs/classes/Player/GetViewModel.md @@ -18,7 +18,7 @@ lua: type: number default: "0" returns: - - type: entity + - type: Entity description: "The player's view model." --- diff --git a/docs/classes/Player/GetWeapon.md b/docs/classes/Player/GetWeapon.md index 5393a20084..2e2b416673 100644 --- a/docs/classes/Player/GetWeapon.md +++ b/docs/classes/Player/GetWeapon.md @@ -17,7 +17,7 @@ lua: - name: "index" type: number returns: - - type: entity + - type: Entity description: "The player's weapon." --- diff --git a/docs/classes/Player/ShowMessage.md b/docs/classes/Player/ShowMessage.md new file mode 100644 index 0000000000..b748d16c58 --- /dev/null +++ b/docs/classes/Player/ShowMessage.md @@ -0,0 +1,25 @@ +--- +template: lua-class-function.html +title: ShowMessage +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Player + function: ShowMessage + realm: server + description: "Show a message to the player." + + arguments: + - name: "message" + type: string + returns: + +--- + +
+Player:ShowMessage – Show a message to the player. +
diff --git a/docs/classes/Player/SprayDecal.md b/docs/classes/Player/SprayDecal.md new file mode 100644 index 0000000000..d0066d5d24 --- /dev/null +++ b/docs/classes/Player/SprayDecal.md @@ -0,0 +1,27 @@ +--- +template: lua-class-function.html +title: SprayDecal +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Player + function: SprayDecal + realm: server + description: "Spray a decal for the player based on a trace with start and end." + + arguments: + - name: "traceStart" + type: Vector + - name: "traceEnd" + type: Vector + returns: + +--- + +
+Player:SprayDecal – Spray a decal for the player based on a trace with start and end. +
diff --git a/docs/classes/UserCommand/GetViewAngles.md b/docs/classes/UserCommand/GetViewAngles.md index 854baa7e09..029b3d710c 100644 --- a/docs/classes/UserCommand/GetViewAngles.md +++ b/docs/classes/UserCommand/GetViewAngles.md @@ -15,7 +15,7 @@ lua: returns: - - type: angle + - type: Angle description: "The view angles" --- diff --git a/docs/libraries/UserMessageReader/ReadAngle.md b/docs/classes/UserMessageReader/ReadAngle.md similarity index 55% rename from docs/libraries/UserMessageReader/ReadAngle.md rename to docs/classes/UserMessageReader/ReadAngle.md index ae5e575184..7377308344 100644 --- a/docs/libraries/UserMessageReader/ReadAngle.md +++ b/docs/classes/UserMessageReader/ReadAngle.md @@ -1,26 +1,24 @@ --- -template: lua-library-function.html +template: lua-class-function.html title: ReadAngle -icon: lua-shared +icon: lua-client tags: - lua - - shared + - client - needs-verification - needs-example lua: library: UserMessageReader function: ReadAngle - realm: shared + realm: client description: "Reads an angle." - arguments: - - name: "reader" - type: UserMessageReader + returns: - - type: angle + - type: Angle description: "The angle read." ---
-UserMessageReader.ReadAngle – Reads an angle. +UserMessageReader:ReadAngle – Reads an angle.
diff --git a/docs/libraries/UserMessageReader/ReadBit.md b/docs/classes/UserMessageReader/ReadBit.md similarity index 58% rename from docs/libraries/UserMessageReader/ReadBit.md rename to docs/classes/UserMessageReader/ReadBit.md index 9b94168647..d713589349 100644 --- a/docs/libraries/UserMessageReader/ReadBit.md +++ b/docs/classes/UserMessageReader/ReadBit.md @@ -1,26 +1,24 @@ --- -template: lua-library-function.html +template: lua-class-function.html title: ReadBit -icon: lua-shared +icon: lua-client tags: - lua - - shared + - client - needs-verification - needs-example lua: library: UserMessageReader function: ReadBit - realm: shared + realm: client description: "Reads a bit." - arguments: - - name: "reader" - type: UserMessageReader + returns: - type: integer description: "The bit read." ---
-UserMessageReader.ReadBit – Reads a bit. +UserMessageReader:ReadBit – Reads a bit.
diff --git a/docs/libraries/UserMessageReader/ReadByte.md b/docs/classes/UserMessageReader/ReadByte.md similarity index 58% rename from docs/libraries/UserMessageReader/ReadByte.md rename to docs/classes/UserMessageReader/ReadByte.md index f8ad2899b9..e84f045e57 100644 --- a/docs/libraries/UserMessageReader/ReadByte.md +++ b/docs/classes/UserMessageReader/ReadByte.md @@ -1,26 +1,24 @@ --- -template: lua-library-function.html +template: lua-class-function.html title: ReadByte -icon: lua-shared +icon: lua-client tags: - lua - - shared + - client - needs-verification - needs-example lua: library: UserMessageReader function: ReadByte - realm: shared + realm: client description: "Reads a byte." - arguments: - - name: "reader" - type: UserMessageReader + returns: - type: integer description: "The byte read." ---
-UserMessageReader.ReadByte – Reads a byte. +UserMessageReader:ReadByte – Reads a byte.
diff --git a/docs/libraries/UserMessageReader/ReadBytes.md b/docs/classes/UserMessageReader/ReadBytes.md similarity index 58% rename from docs/libraries/UserMessageReader/ReadBytes.md rename to docs/classes/UserMessageReader/ReadBytes.md index e2906032b4..730d2fce76 100644 --- a/docs/libraries/UserMessageReader/ReadBytes.md +++ b/docs/classes/UserMessageReader/ReadBytes.md @@ -1,26 +1,24 @@ --- -template: lua-library-function.html +template: lua-class-function.html title: ReadBytes -icon: lua-shared +icon: lua-client tags: - lua - - shared + - client - needs-verification - needs-example lua: library: UserMessageReader function: ReadBytes - realm: shared + realm: client description: "Reads a number of bytes." - arguments: - - name: "reader" - type: UserMessageReader + returns: - type: string description: "The bytes read." ---
-UserMessageReader.ReadBytes – Reads a number of bytes. +UserMessageReader:ReadBytes – Reads a number of bytes.
diff --git a/docs/libraries/UserMessageReader/ReadChar.md b/docs/classes/UserMessageReader/ReadChar.md similarity index 58% rename from docs/libraries/UserMessageReader/ReadChar.md rename to docs/classes/UserMessageReader/ReadChar.md index 192f22c6c1..d1bf926a20 100644 --- a/docs/libraries/UserMessageReader/ReadChar.md +++ b/docs/classes/UserMessageReader/ReadChar.md @@ -1,26 +1,24 @@ --- -template: lua-library-function.html +template: lua-class-function.html title: ReadChar -icon: lua-shared +icon: lua-client tags: - lua - - shared + - client - needs-verification - needs-example lua: library: UserMessageReader function: ReadChar - realm: shared + realm: client description: "Reads a char." - arguments: - - name: "reader" - type: UserMessageReader + returns: - type: integer description: "The char read." ---
-UserMessageReader.ReadChar – Reads a char. +UserMessageReader:ReadChar – Reads a char.
diff --git a/docs/libraries/UserMessageReader/ReadEntity.md b/docs/classes/UserMessageReader/ReadEntity.md similarity index 55% rename from docs/libraries/UserMessageReader/ReadEntity.md rename to docs/classes/UserMessageReader/ReadEntity.md index 55ab33f7ae..f641d51e30 100644 --- a/docs/libraries/UserMessageReader/ReadEntity.md +++ b/docs/classes/UserMessageReader/ReadEntity.md @@ -1,26 +1,24 @@ --- -template: lua-library-function.html +template: lua-class-function.html title: ReadEntity -icon: lua-shared +icon: lua-client tags: - lua - - shared + - client - needs-verification - needs-example lua: library: UserMessageReader function: ReadEntity - realm: shared + realm: client description: "Reads an entity." - arguments: - - name: "reader" - type: UserMessageReader + returns: - - type: entity + - type: Entity description: "The entity read." ---
-UserMessageReader.ReadEntity – Reads an entity. +UserMessageReader:ReadEntity – Reads an entity.
diff --git a/docs/libraries/UserMessageReader/ReadFloat.md b/docs/classes/UserMessageReader/ReadFloat.md similarity index 58% rename from docs/libraries/UserMessageReader/ReadFloat.md rename to docs/classes/UserMessageReader/ReadFloat.md index 2cfb255751..56b2cc00d1 100644 --- a/docs/libraries/UserMessageReader/ReadFloat.md +++ b/docs/classes/UserMessageReader/ReadFloat.md @@ -1,26 +1,24 @@ --- -template: lua-library-function.html +template: lua-class-function.html title: ReadFloat -icon: lua-shared +icon: lua-client tags: - lua - - shared + - client - needs-verification - needs-example lua: library: UserMessageReader function: ReadFloat - realm: shared + realm: client description: "Reads a float." - arguments: - - name: "reader" - type: UserMessageReader + returns: - type: number description: "The float read." ---
-UserMessageReader.ReadFloat – Reads a float. +UserMessageReader:ReadFloat – Reads a float.
diff --git a/docs/libraries/UserMessageReader/ReadLong.md b/docs/classes/UserMessageReader/ReadLong.md similarity index 58% rename from docs/libraries/UserMessageReader/ReadLong.md rename to docs/classes/UserMessageReader/ReadLong.md index 14215c55dd..bb83063171 100644 --- a/docs/libraries/UserMessageReader/ReadLong.md +++ b/docs/classes/UserMessageReader/ReadLong.md @@ -1,26 +1,24 @@ --- -template: lua-library-function.html +template: lua-class-function.html title: ReadLong -icon: lua-shared +icon: lua-client tags: - lua - - shared + - client - needs-verification - needs-example lua: library: UserMessageReader function: ReadLong - realm: shared + realm: client description: "Reads a long integer." - arguments: - - name: "reader" - type: UserMessageReader + returns: - type: integer description: "The long read." ---
-UserMessageReader.ReadLong – Reads a long integer. +UserMessageReader:ReadLong – Reads a long integer.
diff --git a/docs/libraries/UserMessageReader/ReadShort.md b/docs/classes/UserMessageReader/ReadShort.md similarity index 58% rename from docs/libraries/UserMessageReader/ReadShort.md rename to docs/classes/UserMessageReader/ReadShort.md index d7521af7eb..c995b9a6ad 100644 --- a/docs/libraries/UserMessageReader/ReadShort.md +++ b/docs/classes/UserMessageReader/ReadShort.md @@ -1,26 +1,24 @@ --- -template: lua-library-function.html +template: lua-class-function.html title: ReadShort -icon: lua-shared +icon: lua-client tags: - lua - - shared + - client - needs-verification - needs-example lua: library: UserMessageReader function: ReadShort - realm: shared + realm: client description: "Reads a short integer." - arguments: - - name: "reader" - type: UserMessageReader + returns: - type: integer description: "The short read." ---
-UserMessageReader.ReadShort – Reads a short integer. +UserMessageReader:ReadShort – Reads a short integer.
diff --git a/docs/libraries/UserMessageReader/ReadString.md b/docs/classes/UserMessageReader/ReadString.md similarity index 59% rename from docs/libraries/UserMessageReader/ReadString.md rename to docs/classes/UserMessageReader/ReadString.md index ddc9f91f30..a37eb8becc 100644 --- a/docs/libraries/UserMessageReader/ReadString.md +++ b/docs/classes/UserMessageReader/ReadString.md @@ -1,26 +1,24 @@ --- -template: lua-library-function.html +template: lua-class-function.html title: ReadString -icon: lua-shared +icon: lua-client tags: - lua - - shared + - client - needs-verification - needs-example lua: library: UserMessageReader function: ReadString - realm: shared + realm: client description: "Reads a string." - arguments: - - name: "reader" - type: UserMessageReader + returns: - type: string description: "The string read." ---
-UserMessageReader.ReadString – Reads a string. +UserMessageReader:ReadString – Reads a string.
diff --git a/docs/libraries/UserMessageReader/ReadVector.md b/docs/classes/UserMessageReader/ReadVector.md similarity index 55% rename from docs/libraries/UserMessageReader/ReadVector.md rename to docs/classes/UserMessageReader/ReadVector.md index cf38017c25..b6badeb2cd 100644 --- a/docs/libraries/UserMessageReader/ReadVector.md +++ b/docs/classes/UserMessageReader/ReadVector.md @@ -1,26 +1,24 @@ --- -template: lua-library-function.html +template: lua-class-function.html title: ReadVector -icon: lua-shared +icon: lua-client tags: - lua - - shared + - client - needs-verification - needs-example lua: library: UserMessageReader function: ReadVector - realm: shared + realm: client description: "Reads a vector." - arguments: - - name: "reader" - type: UserMessageReader + returns: - - type: vector + - type: Vector description: "The vector read." ---
-UserMessageReader.ReadVector – Reads a vector. +UserMessageReader:ReadVector – Reads a vector.
diff --git a/docs/libraries/UserMessageReader/ReadVectorNormal.md b/docs/classes/UserMessageReader/ReadVectorNormal.md similarity index 56% rename from docs/libraries/UserMessageReader/ReadVectorNormal.md rename to docs/classes/UserMessageReader/ReadVectorNormal.md index 606eb2e071..f5a7e5ece5 100644 --- a/docs/libraries/UserMessageReader/ReadVectorNormal.md +++ b/docs/classes/UserMessageReader/ReadVectorNormal.md @@ -1,26 +1,24 @@ --- -template: lua-library-function.html +template: lua-class-function.html title: ReadVectorNormal -icon: lua-shared +icon: lua-client tags: - lua - - shared + - client - needs-verification - needs-example lua: library: UserMessageReader function: ReadVectorNormal - realm: shared + realm: client description: "Reads a normal vector." - arguments: - - name: "reader" - type: UserMessageReader + returns: - - type: vector + - type: Vector description: "The normal vector read." ---
-UserMessageReader.ReadVectorNormal – Reads a normal vector. +UserMessageReader:ReadVectorNormal – Reads a normal vector.
diff --git a/docs/libraries/UserMessageReader/ReadWord.md b/docs/classes/UserMessageReader/ReadWord.md similarity index 58% rename from docs/libraries/UserMessageReader/ReadWord.md rename to docs/classes/UserMessageReader/ReadWord.md index 8e2501dc1a..8bdb793d20 100644 --- a/docs/libraries/UserMessageReader/ReadWord.md +++ b/docs/classes/UserMessageReader/ReadWord.md @@ -1,26 +1,24 @@ --- -template: lua-library-function.html +template: lua-class-function.html title: ReadWord -icon: lua-shared +icon: lua-client tags: - lua - - shared + - client - needs-verification - needs-example lua: library: UserMessageReader function: ReadWord - realm: shared + realm: client description: "Reads a word." - arguments: - - name: "reader" - type: UserMessageReader + returns: - type: integer description: "The word read." ---
-UserMessageReader.ReadWord – Reads a word. +UserMessageReader:ReadWord – Reads a word.
diff --git a/docs/classes/UserMessageReader/__index.md b/docs/classes/UserMessageReader/__index.md index 5491ce1631..185cb20641 100644 --- a/docs/classes/UserMessageReader/__index.md +++ b/docs/classes/UserMessageReader/__index.md @@ -1,16 +1,16 @@ --- template: lua-class-function.html title: __index -icon: lua-shared +icon: lua-client tags: - lua - - shared + - client - needs-verification - needs-example lua: library: UserMessageReader function: __index - realm: shared + realm: client description: "Returns nil." arguments: diff --git a/docs/classes/UserMessageReader/__tostring.md b/docs/classes/UserMessageReader/__tostring.md index 6807c7362f..07f0a949eb 100644 --- a/docs/classes/UserMessageReader/__tostring.md +++ b/docs/classes/UserMessageReader/__tostring.md @@ -1,16 +1,16 @@ --- template: lua-class-function.html title: __tostring -icon: lua-shared +icon: lua-client tags: - lua - - shared + - client - needs-verification - needs-example lua: library: UserMessageReader function: __tostring - realm: shared + realm: client description: "Returns a string representation of the reader." diff --git a/docs/classes/Vector/Angle.md b/docs/classes/Vector/Angle.md index ccc9766017..fe680db039 100644 --- a/docs/classes/Vector/Angle.md +++ b/docs/classes/Vector/Angle.md @@ -15,7 +15,7 @@ lua: returns: - - type: angle + - type: Angle description: "The converted angle." --- diff --git a/docs/classes/Vector/AngleWithUp.md b/docs/classes/Vector/AngleWithUp.md index 6d11e04018..0fef9d244d 100644 --- a/docs/classes/Vector/AngleWithUp.md +++ b/docs/classes/Vector/AngleWithUp.md @@ -17,7 +17,7 @@ lua: - name: "up" type: Vector returns: - - type: angle + - type: Angle description: "The converted angle." --- diff --git a/docs/classes/Vector/Cross.md b/docs/classes/Vector/Cross.md index 0242dacbff..4f35249afd 100644 --- a/docs/classes/Vector/Cross.md +++ b/docs/classes/Vector/Cross.md @@ -17,7 +17,7 @@ lua: - name: "vector2" type: Vector returns: - - type: vector + - type: Vector description: "The cross product of the two vectors." --- diff --git a/docs/classes/Vector/GetGreatest.md b/docs/classes/Vector/GetGreatest.md index 8301789475..bceb585c52 100644 --- a/docs/classes/Vector/GetGreatest.md +++ b/docs/classes/Vector/GetGreatest.md @@ -17,7 +17,7 @@ lua: - name: "vector2" type: Vector returns: - - type: vector + - type: Vector description: "The maximum values of the two vectors." --- diff --git a/docs/classes/Vector/GetSmallest.md b/docs/classes/Vector/GetSmallest.md index 74920dd479..8d96347ba2 100644 --- a/docs/classes/Vector/GetSmallest.md +++ b/docs/classes/Vector/GetSmallest.md @@ -17,7 +17,7 @@ lua: - name: "vector2" type: Vector returns: - - type: vector + - type: Vector description: "The minimum values of the two vectors." --- diff --git a/docs/classes/Vector/__add.md b/docs/classes/Vector/__add.md index 4248353827..4280a18956 100644 --- a/docs/classes/Vector/__add.md +++ b/docs/classes/Vector/__add.md @@ -17,7 +17,7 @@ lua: - name: "vectorB" type: Vector returns: - - type: vector + - type: Vector description: "The sum of the two vectors." --- diff --git a/docs/classes/Vector/__div.md b/docs/classes/Vector/__div.md index 3b5cc864b3..b0af8fd95b 100644 --- a/docs/classes/Vector/__div.md +++ b/docs/classes/Vector/__div.md @@ -17,7 +17,7 @@ lua: - name: "number" type: number returns: - - type: vector + - type: Vector description: "The vector divided by the number." --- diff --git a/docs/classes/Vector/__mul.md b/docs/classes/Vector/__mul.md index 735a879d52..1bc2c40e31 100644 --- a/docs/classes/Vector/__mul.md +++ b/docs/classes/Vector/__mul.md @@ -24,7 +24,7 @@ lua: - name: "vectorB" type: Vector returns: - - type: vector + - type: Vector description: "The product of the two vectors or the vector and the number." --- diff --git a/docs/classes/Vector/__sub.md b/docs/classes/Vector/__sub.md index 3aaca9e01a..2a6e187a13 100644 --- a/docs/classes/Vector/__sub.md +++ b/docs/classes/Vector/__sub.md @@ -17,7 +17,7 @@ lua: - name: "vectorB" type: Vector returns: - - type: vector + - type: Vector description: "The difference of the two vectors." --- diff --git a/docs/classes/Vector/__unm.md b/docs/classes/Vector/__unm.md index 99b43b99e5..e0b994c702 100644 --- a/docs/classes/Vector/__unm.md +++ b/docs/classes/Vector/__unm.md @@ -15,7 +15,7 @@ lua: returns: - - type: vector + - type: Vector description: "The negated vector." --- diff --git a/docs/classes/Weapon/GetOwner.md b/docs/classes/Weapon/GetOwner.md index 0a44f1baad..d00fdd3a0c 100644 --- a/docs/classes/Weapon/GetOwner.md +++ b/docs/classes/Weapon/GetOwner.md @@ -15,7 +15,7 @@ lua: returns: - - type: entity + - type: Entity description: "Owner entity." --- diff --git a/docs/libraries/_G/ConsoleCommand.md b/docs/libraries/ConsoleCommands/Create.md similarity index 78% rename from docs/libraries/_G/ConsoleCommand.md rename to docs/libraries/ConsoleCommands/Create.md index 4a511d5cf5..df30d4e563 100644 --- a/docs/libraries/_G/ConsoleCommand.md +++ b/docs/libraries/ConsoleCommands/Create.md @@ -1,6 +1,6 @@ --- template: lua-library-function.html -title: ConsoleCommand +title: Create icon: lua-shared tags: - lua @@ -8,8 +8,8 @@ tags: - needs-verification - needs-example lua: - library: _G - function: ConsoleCommand + library: ConsoleCommands + function: Create realm: shared description: "Creates a console command or returns the existing one with the given name" @@ -28,5 +28,5 @@ lua: ---
-_G.ConsoleCommand – Creates a console command or returns the existing one with the given name +ConsoleCommands.Create – Creates a console command or returns the existing one with the given name
diff --git a/docs/libraries/ConsoleCommands/GetCommandClient.md b/docs/libraries/ConsoleCommands/GetCommandClient.md new file mode 100644 index 0000000000..d175f5725d --- /dev/null +++ b/docs/libraries/ConsoleCommands/GetCommandClient.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: GetCommandClient +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: ConsoleCommands + function: GetCommandClient + realm: server + description: "Get the client that issued the command" + + + returns: + - type: Player + description: "The client that issued the command" +--- + +
+ConsoleCommands.GetCommandClient – Get the client that issued the command +
diff --git a/docs/libraries/ConsoleCommands/GetCommandClientIndex.md b/docs/libraries/ConsoleCommands/GetCommandClientIndex.md new file mode 100644 index 0000000000..f0ea0a18ca --- /dev/null +++ b/docs/libraries/ConsoleCommands/GetCommandClientIndex.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: GetCommandClientIndex +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: ConsoleCommands + function: GetCommandClientIndex + realm: server + description: "Get the index of the client that issued the command" + + + returns: + - type: integer + description: "The index of the client that issued the command" +--- + +
+ConsoleCommands.GetCommandClientIndex – Get the index of the client that issued the command +
diff --git a/docs/libraries/ConsoleCommands/IsCommandIssuedByServerAdmin.md b/docs/libraries/ConsoleCommands/IsCommandIssuedByServerAdmin.md new file mode 100644 index 0000000000..119d872017 --- /dev/null +++ b/docs/libraries/ConsoleCommands/IsCommandIssuedByServerAdmin.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: IsCommandIssuedByServerAdmin +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: ConsoleCommands + function: IsCommandIssuedByServerAdmin + realm: server + description: "Whether the command was issued by a server admin" + + + returns: + - type: boolean + description: "Whether the command was issued by a server admin" +--- + +
+ConsoleCommands.IsCommandIssuedByServerAdmin – Whether the command was issued by a server admin +
diff --git a/docs/libraries/_G/EffectData.md b/docs/libraries/Effects/Create.md similarity index 62% rename from docs/libraries/_G/EffectData.md rename to docs/libraries/Effects/Create.md index 43fad2a3f0..29acd17b02 100644 --- a/docs/libraries/_G/EffectData.md +++ b/docs/libraries/Effects/Create.md @@ -1,6 +1,6 @@ --- template: lua-library-function.html -title: EffectData +title: Create icon: lua-shared tags: - lua @@ -8,10 +8,10 @@ tags: - needs-verification - needs-example lua: - library: _G - function: EffectData + library: Effects + function: Create realm: shared - description: "Creates an effect." + description: "Creates an effect (EffectData)." returns: @@ -20,5 +20,5 @@ lua: ---
-_G.EffectData – Creates an effect. +Effects.Create – Creates an effect (EffectData).
diff --git a/docs/libraries/_G/DispatchEffect.md b/docs/libraries/Effects/Dispatch.md similarity index 76% rename from docs/libraries/_G/DispatchEffect.md rename to docs/libraries/Effects/Dispatch.md index 793d1598b4..cf4683fb91 100644 --- a/docs/libraries/_G/DispatchEffect.md +++ b/docs/libraries/Effects/Dispatch.md @@ -1,6 +1,6 @@ --- template: lua-library-function.html -title: DispatchEffect +title: Dispatch icon: lua-shared tags: - lua @@ -8,8 +8,8 @@ tags: - needs-verification - needs-example lua: - library: _G - function: DispatchEffect + library: Effects + function: Dispatch realm: shared description: "Dispatches an effect." @@ -23,5 +23,5 @@ lua: ---
-_G.DispatchEffect – Dispatches an effect. +Effects.Dispatch – Dispatches an effect.
diff --git a/docs/libraries/Effects/SpawnBloodDrips.md b/docs/libraries/Effects/SpawnBloodDrips.md new file mode 100644 index 0000000000..1b8c097fd1 --- /dev/null +++ b/docs/libraries/Effects/SpawnBloodDrips.md @@ -0,0 +1,31 @@ +--- +template: lua-library-function.html +title: SpawnBloodDrips +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Effects + function: SpawnBloodDrips + realm: shared + description: "Creates a blood drip effect." + + arguments: + - name: "origin" + type: Vector + - name: "direction" + type: Vector + - name: "color" + type: number + - name: "amount" + type: number + returns: + +--- + +
+Effects.SpawnBloodDrips – Creates a blood drip effect. +
diff --git a/docs/libraries/Effects/SpawnBloodImpact.md b/docs/libraries/Effects/SpawnBloodImpact.md new file mode 100644 index 0000000000..34ef14331f --- /dev/null +++ b/docs/libraries/Effects/SpawnBloodImpact.md @@ -0,0 +1,31 @@ +--- +template: lua-library-function.html +title: SpawnBloodImpact +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Effects + function: SpawnBloodImpact + realm: shared + description: "Creates a blood impact effect." + + arguments: + - name: "origin" + type: Vector + - name: "direction" + type: Vector + - name: "color" + type: number + - name: "amount" + type: number + returns: + +--- + +
+Effects.SpawnBloodImpact – Creates a blood impact effect. +
diff --git a/docs/libraries/Effects/SpawnBloodSpray.md b/docs/libraries/Effects/SpawnBloodSpray.md new file mode 100644 index 0000000000..45fe8e6e6d --- /dev/null +++ b/docs/libraries/Effects/SpawnBloodSpray.md @@ -0,0 +1,33 @@ +--- +template: lua-library-function.html +title: SpawnBloodSpray +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Effects + function: SpawnBloodSpray + realm: server + description: "Creates a blood spray effect.\nColor can be DONT_BLEED(-1), BLOOD_COLOR_RED(0), BLOOD_COLOR_YELLOW(1), BLOOD_COLOR_GREEN(2), BLOOD_COLOR_MECH(3) - enums don't exist yet in Lua\nFlags can be FX_BLOODSPRAY_DROPS(1), FX_BLOODSPRAY_GORE(2), FX_BLOODSPRAY_CLOUD(4), FX_BLOODSPRAY_ALL(255) - enums don't exist yet in Lua" + + arguments: + - name: "origin" + type: Vector + - name: "direction" + type: Vector + - name: "color" + type: number + - name: "amount" + type: number + - name: "flags" + type: number + returns: + +--- + +
+Effects.SpawnBloodSpray – Creates a blood spray effect.\nColor can be DONT_BLEED(-1), BLOOD_COLOR_RED(0), BLOOD_COLOR_YELLOW(1), BLOOD_COLOR_GREEN(2), BLOOD_COLOR_MECH(3) - enums don't exist yet in Lua\nFlags can be FX_BLOODSPRAY_DROPS(1), FX_BLOODSPRAY_GORE(2), FX_BLOODSPRAY_CLOUD(4), FX_BLOODSPRAY_ALL(255) - enums don't exist yet in Lua +
diff --git a/docs/libraries/Effects/SpawnBloodStream.md b/docs/libraries/Effects/SpawnBloodStream.md new file mode 100644 index 0000000000..1329875e44 --- /dev/null +++ b/docs/libraries/Effects/SpawnBloodStream.md @@ -0,0 +1,31 @@ +--- +template: lua-library-function.html +title: SpawnBloodStream +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Effects + function: SpawnBloodStream + realm: server + description: "Creates a blood stream effect. Color can be DONT_BLEED(-1), BLOOD_COLOR_RED(0), BLOOD_COLOR_YELLOW(1), BLOOD_COLOR_GREEN(2), BLOOD_COLOR_MECH(3) - enums don't exist yet in Lua" + + arguments: + - name: "origin" + type: Vector + - name: "direction" + type: Vector + - name: "color" + type: number + - name: "amount" + type: number + returns: + +--- + +
+Effects.SpawnBloodStream – Creates a blood stream effect. Color can be DONT_BLEED(-1), BLOOD_COLOR_RED(0), BLOOD_COLOR_YELLOW(1), BLOOD_COLOR_GREEN(2), BLOOD_COLOR_MECH(3) - enums don't exist yet in Lua +
diff --git a/docs/libraries/Effects/SpawnBubbleTrail.md b/docs/libraries/Effects/SpawnBubbleTrail.md new file mode 100644 index 0000000000..ce3721bf34 --- /dev/null +++ b/docs/libraries/Effects/SpawnBubbleTrail.md @@ -0,0 +1,29 @@ +--- +template: lua-library-function.html +title: SpawnBubbleTrail +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Effects + function: SpawnBubbleTrail + realm: server + description: "Creates a bubble trail effect." + + arguments: + - name: "start" + type: Vector + - name: "end" + type: Vector + - name: "count" + type: number + returns: + +--- + +
+Effects.SpawnBubbleTrail – Creates a bubble trail effect. +
diff --git a/docs/libraries/Effects/SpawnMuzzleFlash.md b/docs/libraries/Effects/SpawnMuzzleFlash.md new file mode 100644 index 0000000000..4f6c0bfc8e --- /dev/null +++ b/docs/libraries/Effects/SpawnMuzzleFlash.md @@ -0,0 +1,32 @@ +--- +template: lua-library-function.html +title: SpawnMuzzleFlash +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Effects + function: SpawnMuzzleFlash + realm: server + description: "Creates a muzzle flash effect. Types can be MUZZLEFLASH_TYPE_DEFAULT(1), MUZZLEFLASH_TYPE_GUNSHIP(2), MUZZLEFLASH_TYPE_STRIDER(4) - enums don't exist yet in Lua" + + arguments: + - name: "origin" + type: Vector + - name: "angles" + type: Angle + - name: "scale" + type: number + - name: "type" + type: number + default: "MUZZLEFLASH_TYPE_DEFAULT" + returns: + +--- + +
+Effects.SpawnMuzzleFlash – Creates a muzzle flash effect. Types can be MUZZLEFLASH_TYPE_DEFAULT(1), MUZZLEFLASH_TYPE_GUNSHIP(2), MUZZLEFLASH_TYPE_STRIDER(4) - enums don't exist yet in Lua +
diff --git a/docs/libraries/Effects/SpawnParticleTracer.md b/docs/libraries/Effects/SpawnParticleTracer.md new file mode 100644 index 0000000000..e6f9055e95 --- /dev/null +++ b/docs/libraries/Effects/SpawnParticleTracer.md @@ -0,0 +1,38 @@ +--- +template: lua-library-function.html +title: SpawnParticleTracer +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Effects + function: SpawnParticleTracer + realm: shared + description: "Spawns a tracer particle effect." + + arguments: + - name: "effect" + type: string + - name: "start" + type: Vector + - name: "end" + type: Vector + - name: "whiz" + type: boolean + default: "false" + - name: "entityIndex" + type: number + default: "0" + - name: "attachment" + type: number + default: "0" + returns: + +--- + +
+Effects.SpawnParticleTracer – Spawns a tracer particle effect. +
diff --git a/docs/libraries/Effects/SpawnTracer.md b/docs/libraries/Effects/SpawnTracer.md new file mode 100644 index 0000000000..b0d11f3df0 --- /dev/null +++ b/docs/libraries/Effects/SpawnTracer.md @@ -0,0 +1,45 @@ +--- +template: lua-library-function.html +title: SpawnTracer +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Effects + function: SpawnTracer + realm: shared + description: "Creates a tracer effect." + + arguments: + - name: "start" + type: Vector + - name: "end" + type: Vector + - name: "entityIndex" + type: number + default: "0" + - name: "attachment" + type: number + default: "0" + - name: "velocity" + type: number + default: "0" + - name: "shouldWhiz" + type: boolean + default: "false" + - name: "customTracerName" + type: string + default: "NULL" + - name: "particleId" + type: number + default: "0" + returns: + +--- + +
+Effects.SpawnTracer – Creates a tracer effect. +
diff --git a/docs/libraries/UserMessageReader/index.md b/docs/libraries/Effects/index.md similarity index 59% rename from docs/libraries/UserMessageReader/index.md rename to docs/libraries/Effects/index.md index 75129b7890..fe97e3f1ae 100644 --- a/docs/libraries/UserMessageReader/index.md +++ b/docs/libraries/Effects/index.md @@ -2,9 +2,9 @@ template: lua-index.html childrenTitle: Functions include: - startsWith: libraries/UserMessageReader/ + startsWith: libraries/Effects/ exclude: isIndex: true --- -# UserMessageReader +# Effects diff --git a/docs/libraries/Engines/CreateFakeClient.md b/docs/libraries/Engines/CreateFakeClient.md index a586cdc611..3d4536aa32 100644 --- a/docs/libraries/Engines/CreateFakeClient.md +++ b/docs/libraries/Engines/CreateFakeClient.md @@ -17,7 +17,7 @@ lua: - name: "name" type: string returns: - - type: entity + - type: Entity description: "The created fake client." --- diff --git a/docs/libraries/Engines/GetLightForPoint.md b/docs/libraries/Engines/GetLightForPoint.md index 918665f91b..b2dec05839 100644 --- a/docs/libraries/Engines/GetLightForPoint.md +++ b/docs/libraries/Engines/GetLightForPoint.md @@ -19,7 +19,7 @@ lua: - name: "clamp" type: boolean returns: - - type: vector + - type: Vector description: "The light for the point." --- diff --git a/docs/libraries/Engines/GetLightForPointFast.md b/docs/libraries/Engines/GetLightForPointFast.md index 09d1270a54..21b908e376 100644 --- a/docs/libraries/Engines/GetLightForPointFast.md +++ b/docs/libraries/Engines/GetLightForPointFast.md @@ -19,7 +19,7 @@ lua: - name: "clamp" type: boolean returns: - - type: vector + - type: Vector description: "The light for the point." --- diff --git a/docs/libraries/Engines/GetListenServerHost.md b/docs/libraries/Engines/GetListenServerHost.md new file mode 100644 index 0000000000..02720537e9 --- /dev/null +++ b/docs/libraries/Engines/GetListenServerHost.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: GetListenServerHost +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Engines + function: GetListenServerHost + realm: server + description: "Get the local player on a listen server - this is for multiplayer use only." + + + returns: + - type: Entity + description: "The listen server host." +--- + +
+Engines.GetListenServerHost – Get the local player on a listen server - this is for multiplayer use only. +
diff --git a/docs/libraries/Engines/GetSimulationInterval.md b/docs/libraries/Engines/GetSimulationInterval.md new file mode 100644 index 0000000000..58e48721f2 --- /dev/null +++ b/docs/libraries/Engines/GetSimulationInterval.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: GetSimulationInterval +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Engines + function: GetSimulationInterval + realm: server + description: "Get the simulation interval." + + + returns: + - type: number + description: "The simulation interval." +--- + +
+Engines.GetSimulationInterval – Get the simulation interval. +
diff --git a/docs/libraries/Entities/CanCreateEntityClass.md b/docs/libraries/Entities/CanCreateEntityClass.md new file mode 100644 index 0000000000..037b6bc2e4 --- /dev/null +++ b/docs/libraries/Entities/CanCreateEntityClass.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: CanCreateEntityClass +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entities + function: CanCreateEntityClass + realm: server + description: "Checks if an entity class can be created" + + arguments: + - name: "className" + type: string + returns: + - type: boolean + description: "True if the entity class can be created, false otherwise." +--- + +
+Entities.CanCreateEntityClass – Checks if an entity class can be created +
diff --git a/docs/libraries/Entities/DisableRemoveImmediate.md b/docs/libraries/Entities/DisableRemoveImmediate.md new file mode 100644 index 0000000000..477ceeddc0 --- /dev/null +++ b/docs/libraries/Entities/DisableRemoveImmediate.md @@ -0,0 +1,23 @@ +--- +template: lua-library-function.html +title: DisableRemoveImmediate +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entities + function: DisableRemoveImmediate + realm: server + description: "Disables immediate removal of entities" + + + returns: + +--- + +
+Entities.DisableRemoveImmediate – Disables immediate removal of entities +
diff --git a/docs/libraries/Entities/EnableRemoveImmediate.md b/docs/libraries/Entities/EnableRemoveImmediate.md new file mode 100644 index 0000000000..cdb7e2fde4 --- /dev/null +++ b/docs/libraries/Entities/EnableRemoveImmediate.md @@ -0,0 +1,23 @@ +--- +template: lua-library-function.html +title: EnableRemoveImmediate +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entities + function: EnableRemoveImmediate + realm: server + description: "Enables immediate removal of entities" + + + returns: + +--- + +
+Entities.EnableRemoveImmediate – Enables immediate removal of entities +
diff --git a/docs/libraries/Entities/FNullEnt.md b/docs/libraries/Entities/FNullEnt.md new file mode 100644 index 0000000000..429fe5ef83 --- /dev/null +++ b/docs/libraries/Entities/FNullEnt.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: FNullEnt +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entities + function: FNullEnt + realm: server + description: "Checks if an entity is NULL" + + arguments: + - name: "entity" + type: Entity + returns: + - type: boolean + description: "True if the entity is NULL, false otherwise." +--- + +
+Entities.FNullEnt – Checks if an entity is NULL +
diff --git a/docs/libraries/Entities/FindByEdictNumber.md b/docs/libraries/Entities/FindByEdictNumber.md new file mode 100644 index 0000000000..20f06a8ba2 --- /dev/null +++ b/docs/libraries/Entities/FindByEdictNumber.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: FindByEdictNumber +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entities + function: FindByEdictNumber + realm: server + description: "Gets an entity by its edict number" + + arguments: + - name: "edictNumber" + type: integer + returns: + - type: Entity + description: "The entity found, or NULL if not found." +--- + +
+Entities.FindByEdictNumber – Gets an entity by its edict number +
diff --git a/docs/libraries/Entities/FindByIndex.md b/docs/libraries/Entities/FindByIndex.md new file mode 100644 index 0000000000..64d7a406a7 --- /dev/null +++ b/docs/libraries/Entities/FindByIndex.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: FindByIndex +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entities + function: FindByIndex + realm: server + description: "Gets an entity by its index. Might be the same as FindByEdictNumber?" + + arguments: + - name: "index" + type: integer + returns: + - type: Entity + description: "The entity found, or NULL if not found." +--- + +
+Entities.FindByIndex – Gets an entity by its index. Might be the same as FindByEdictNumber? +
diff --git a/docs/libraries/Entities/FindClientInPvs.md b/docs/libraries/Entities/FindClientInPvs.md new file mode 100644 index 0000000000..190c3c237d --- /dev/null +++ b/docs/libraries/Entities/FindClientInPvs.md @@ -0,0 +1,28 @@ +--- +template: lua-library-function.html +title: FindClientInPvs +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entities + function: FindClientInPvs + realm: server + description: "Finds a client in the PVS" + + arguments: + - name: "minimumVector" + type: Vector + - name: "maximumVector" + type: Vector + returns: + - type: Entity + description: "The entity found, or NULL if not found." +--- + +
+Entities.FindClientInPvs – Finds a client in the PVS +
diff --git a/docs/libraries/Entities/GetAlongRay.md b/docs/libraries/Entities/GetAlongRay.md new file mode 100644 index 0000000000..22cd00b9fc --- /dev/null +++ b/docs/libraries/Entities/GetAlongRay.md @@ -0,0 +1,34 @@ +--- +template: lua-library-function.html +title: GetAlongRay +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Entities + function: GetAlongRay + realm: shared + description: "Finds all entities along the given ray." + + arguments: + - name: "start" + type: Vector + - name: "end" + type: Vector + - name: "mins" + type: Vector + - name: "maxs" + type: Vector + returns: + - type: table + description: "A table of entities found." + - type: number + description: "The number of entities found." +--- + +
+Entities.GetAlongRay – Finds all entities along the given ray. +
diff --git a/docs/libraries/Entities/GetClientPvsIsExpanded.md b/docs/libraries/Entities/GetClientPvsIsExpanded.md new file mode 100644 index 0000000000..91ec9aec32 --- /dev/null +++ b/docs/libraries/Entities/GetClientPvsIsExpanded.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: GetClientPvsIsExpanded +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entities + function: GetClientPvsIsExpanded + realm: server + description: "Checks if the client PVS is expanded" + + + returns: + - type: boolean + description: "True if the client PVS is expanded, false otherwise." +--- + +
+Entities.GetClientPvsIsExpanded – Checks if the client PVS is expanded +
diff --git a/docs/libraries/Entities/GetInBox.md b/docs/libraries/Entities/GetInBox.md new file mode 100644 index 0000000000..15a529ce02 --- /dev/null +++ b/docs/libraries/Entities/GetInBox.md @@ -0,0 +1,36 @@ +--- +template: lua-library-function.html +title: GetInBox +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Entities + function: GetInBox + realm: shared + description: "Finds all entities in the given box. Note that clientPartitionMask is only available on the client." + + arguments: + - name: "mins" + type: Vector + - name: "maxs" + type: Vector + - name: "flagMask" + type: integer + default: "PARTITION_CLIENT_NON_STATIC_EDICTS" + - name: "clientPartitionMask" + type: integer + default: "PARTITION_CLIENT_NON_STATIC_EDICTS" + returns: + - type: table + description: "A table of entities found." + - type: number + description: "The number of entities found." +--- + +
+Entities.GetInBox – Finds all entities in the given box. Note that clientPartitionMask is only available on the client. +
diff --git a/docs/libraries/Entities/GetInPvs.md b/docs/libraries/Entities/GetInPvs.md new file mode 100644 index 0000000000..91ca7d51f4 --- /dev/null +++ b/docs/libraries/Entities/GetInPvs.md @@ -0,0 +1,28 @@ +--- +template: lua-library-function.html +title: GetInPvs +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entities + function: GetInPvs + realm: server + description: "Goes through the entities and find the ones that are in the PVS of the provided vector." + + arguments: + - name: "viewOrigin" + type: Vector + returns: + - type: table + description: "A table of entities found." + - type: number + description: "The number of entities found." +--- + +
+Entities.GetInPvs – Goes through the entities and find the ones that are in the PVS of the provided vector. +
diff --git a/docs/libraries/Entities/GetInSphere.md b/docs/libraries/Entities/GetInSphere.md new file mode 100644 index 0000000000..57658343ad --- /dev/null +++ b/docs/libraries/Entities/GetInSphere.md @@ -0,0 +1,36 @@ +--- +template: lua-library-function.html +title: GetInSphere +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Entities + function: GetInSphere + realm: shared + description: "Finds all entities in the given sphere. Note that clientPartitionMask is only available on the client." + + arguments: + - name: "position" + type: Vector + - name: "radius" + type: number + - name: "flagMask" + type: integer + default: "PARTITION_CLIENT_NON_STATIC_EDICTS" + - name: "partitionMask" + type: integer + default: "PARTITION_CLIENT_NON_STATIC_EDICTS" + returns: + - type: table + description: "A table of entities found." + - type: number + description: "The number of entities found." +--- + +
+Entities.GetInSphere – Finds all entities in the given sphere. Note that clientPartitionMask is only available on the client. +
diff --git a/docs/libraries/Entities/IsValidEdict.md b/docs/libraries/Entities/IsValidEdict.md new file mode 100644 index 0000000000..824a3db7e2 --- /dev/null +++ b/docs/libraries/Entities/IsValidEdict.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: IsValidEdict +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entities + function: IsValidEdict + realm: server + description: "Checks if an entity is valid by checking if it's edict is valid and not free" + + arguments: + - name: "entity" + type: Entity + returns: + - type: boolean + description: "True if the entity is valid, false otherwise." +--- + +
+Entities.IsValidEdict – Checks if an entity is valid by checking if it's edict is valid and not free +
diff --git a/docs/libraries/Entities/Remove.md b/docs/libraries/Entities/Remove.md new file mode 100644 index 0000000000..145c7e3701 --- /dev/null +++ b/docs/libraries/Entities/Remove.md @@ -0,0 +1,25 @@ +--- +template: lua-library-function.html +title: Remove +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entities + function: Remove + realm: server + description: "Removes an entity" + + arguments: + - name: "entity" + type: Entity + returns: + +--- + +
+Entities.Remove – Removes an entity +
diff --git a/docs/libraries/Entities/RemoveImmediate.md b/docs/libraries/Entities/RemoveImmediate.md new file mode 100644 index 0000000000..a1fc5bebe5 --- /dev/null +++ b/docs/libraries/Entities/RemoveImmediate.md @@ -0,0 +1,25 @@ +--- +template: lua-library-function.html +title: RemoveImmediate +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Entities + function: RemoveImmediate + realm: server + description: "Removes an entity immediately" + + arguments: + - name: "entity" + type: Entity + returns: + +--- + +
+Entities.RemoveImmediate – Removes an entity immediately +
diff --git a/docs/libraries/Matrices/CalculateAabbFromProjectionMatrix.md b/docs/libraries/Matrices/CalculateAabbFromProjectionMatrix.md index 541b036b51..bf318705c5 100644 --- a/docs/libraries/Matrices/CalculateAabbFromProjectionMatrix.md +++ b/docs/libraries/Matrices/CalculateAabbFromProjectionMatrix.md @@ -17,7 +17,7 @@ lua: - name: "Matrix" type: Matrix returns: - - type: vector + - type: Vector description: "The minimum vector." - type: vector description: "The maximum vector." diff --git a/docs/libraries/Matrices/CalculateSphereFromProjectionMatrix.md b/docs/libraries/Matrices/CalculateSphereFromProjectionMatrix.md index 4b6a6db99e..3a25442654 100644 --- a/docs/libraries/Matrices/CalculateSphereFromProjectionMatrix.md +++ b/docs/libraries/Matrices/CalculateSphereFromProjectionMatrix.md @@ -17,7 +17,7 @@ lua: - name: "Matrix" type: Matrix returns: - - type: vector + - type: Vector description: "The center vector." - type: number description: "The radius." diff --git a/docs/libraries/Matrices/MatrixGetColumn.md b/docs/libraries/Matrices/MatrixGetColumn.md index 5106fd7178..5706796eda 100644 --- a/docs/libraries/Matrices/MatrixGetColumn.md +++ b/docs/libraries/Matrices/MatrixGetColumn.md @@ -17,7 +17,7 @@ lua: - name: "Matrix" type: Matrix returns: - - type: vector + - type: Vector description: "The column vector." --- diff --git a/docs/libraries/Matrices/MatrixGetRow.md b/docs/libraries/Matrices/MatrixGetRow.md index ab732f5d61..eb792dc70e 100644 --- a/docs/libraries/Matrices/MatrixGetRow.md +++ b/docs/libraries/Matrices/MatrixGetRow.md @@ -17,7 +17,7 @@ lua: - name: "Matrix" type: Matrix returns: - - type: vector + - type: Vector description: "The row vector." --- diff --git a/docs/libraries/Matrices/Vector3dMultiply.md b/docs/libraries/Matrices/Vector3dMultiply.md index 3ef0d71d08..632285918d 100644 --- a/docs/libraries/Matrices/Vector3dMultiply.md +++ b/docs/libraries/Matrices/Vector3dMultiply.md @@ -17,7 +17,7 @@ lua: - name: "Matrix" type: Matrix returns: - - type: vector + - type: Vector description: "The multiplied vector." --- diff --git a/docs/libraries/Matrices/Vector3dMultiplyPositionProjective.md b/docs/libraries/Matrices/Vector3dMultiplyPositionProjective.md index a3a4348903..566c1ddbb7 100644 --- a/docs/libraries/Matrices/Vector3dMultiplyPositionProjective.md +++ b/docs/libraries/Matrices/Vector3dMultiplyPositionProjective.md @@ -17,7 +17,7 @@ lua: - name: "Matrix" type: Matrix returns: - - type: vector + - type: Vector description: "The multiplied vector." --- diff --git a/docs/libraries/Matrices/Vector3dMultiplyProjective.md b/docs/libraries/Matrices/Vector3dMultiplyProjective.md index 5b12156011..21af89ef71 100644 --- a/docs/libraries/Matrices/Vector3dMultiplyProjective.md +++ b/docs/libraries/Matrices/Vector3dMultiplyProjective.md @@ -17,7 +17,7 @@ lua: - name: "Matrix" type: Matrix returns: - - type: vector + - type: Vector description: "The multiplied vector." --- diff --git a/docs/libraries/Matrices/Vector3dMultiplyTranspose.md b/docs/libraries/Matrices/Vector3dMultiplyTranspose.md index e4077fb77e..5319609f1b 100644 --- a/docs/libraries/Matrices/Vector3dMultiplyTranspose.md +++ b/docs/libraries/Matrices/Vector3dMultiplyTranspose.md @@ -17,7 +17,7 @@ lua: - name: "Matrix" type: Matrix returns: - - type: vector + - type: Vector description: "The multiplied vector." --- diff --git a/docs/libraries/NetworkStringTables/CreateStringTable.md b/docs/libraries/NetworkStringTables/Create.md similarity index 82% rename from docs/libraries/NetworkStringTables/CreateStringTable.md rename to docs/libraries/NetworkStringTables/Create.md index d6a032bf68..f735503090 100644 --- a/docs/libraries/NetworkStringTables/CreateStringTable.md +++ b/docs/libraries/NetworkStringTables/Create.md @@ -1,6 +1,6 @@ --- template: lua-library-function.html -title: CreateStringTable +title: Create icon: lua-shared tags: - lua @@ -9,7 +9,7 @@ tags: - needs-example lua: library: NetworkStringTables - function: CreateStringTable + function: Create realm: shared description: "Create a new string table." @@ -30,5 +30,5 @@ lua: ---
-NetworkStringTables.CreateStringTable – Create a new string table. +NetworkStringTables.Create – Create a new string table.
diff --git a/docs/libraries/NetworkStringTables/CreateStringTableEx.md b/docs/libraries/NetworkStringTables/CreateExtended.md similarity index 83% rename from docs/libraries/NetworkStringTables/CreateStringTableEx.md rename to docs/libraries/NetworkStringTables/CreateExtended.md index 2d610f6f83..ec4745e357 100644 --- a/docs/libraries/NetworkStringTables/CreateStringTableEx.md +++ b/docs/libraries/NetworkStringTables/CreateExtended.md @@ -1,6 +1,6 @@ --- template: lua-library-function.html -title: CreateStringTableEx +title: CreateExtended icon: lua-shared tags: - lua @@ -9,7 +9,7 @@ tags: - needs-example lua: library: NetworkStringTables - function: CreateStringTableEx + function: CreateExtended realm: shared description: "Create a new string table." @@ -33,5 +33,5 @@ lua: ---
-NetworkStringTables.CreateStringTableEx – Create a new string table. +NetworkStringTables.CreateExtended – Create a new string table.
diff --git a/docs/libraries/Player/SayText.md b/docs/libraries/Player/SayText.md new file mode 100644 index 0000000000..d7d2ebef6f --- /dev/null +++ b/docs/libraries/Player/SayText.md @@ -0,0 +1,27 @@ +--- +template: lua-library-function.html +title: SayText +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Player + function: SayText + realm: server + description: "Say text to a player." + + arguments: + - name: "text" + type: string + - name: "player" + type: Player + returns: + +--- + +
+Player.SayText – Say text to a player. +
diff --git a/docs/libraries/Player/index.md b/docs/libraries/Player/index.md new file mode 100644 index 0000000000..6bd8cede79 --- /dev/null +++ b/docs/libraries/Player/index.md @@ -0,0 +1,10 @@ +--- +template: lua-index.html +childrenTitle: Functions +include: + startsWith: libraries/Player/ +exclude: + isIndex: true +--- + +# Player diff --git a/docs/libraries/Players/ClientPrintToAll.md b/docs/libraries/Players/ClientPrintToAll.md new file mode 100644 index 0000000000..3ad3dc6fcc --- /dev/null +++ b/docs/libraries/Players/ClientPrintToAll.md @@ -0,0 +1,39 @@ +--- +template: lua-library-function.html +title: ClientPrintToAll +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: ClientPrintToAll + realm: shared + description: "Print text to all clients, optionally substituting 4 strings. The type decides where to show it: HUD_PRINTCENTER (1), HUD_PRINTNOTIFY (2), HUD_PRINTTALK (3), HUD_PRINTCONSOLE (4) - Enums don't exist yet" + + arguments: + - name: "messageType" + type: integer + - name: "message" + type: string + - name: "subsitution1" + type: string + default: "NULL" + - name: "subsitution2" + type: string + default: "NULL" + - name: "subsitution3" + type: string + default: "NULL" + - name: "subsitution4" + type: string + default: "NULL" + returns: + +--- + +
+Players.ClientPrintToAll – Print text to all clients, optionally substituting 4 strings. The type decides where to show it: HUD_PRINTCENTER (1), HUD_PRINTNOTIFY (2), HUD_PRINTTALK (3), HUD_PRINTCONSOLE (4) - Enums don't exist yet +
diff --git a/docs/libraries/Players/FindByIndex.md b/docs/libraries/Players/FindByIndex.md new file mode 100644 index 0000000000..a545a751d0 --- /dev/null +++ b/docs/libraries/Players/FindByIndex.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: FindByIndex +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: FindByIndex + realm: shared + description: "Get a player by index." + + arguments: + - name: "index" + type: number + returns: + - type: Player + description: "The player." +--- + +
+Players.FindByIndex – Get a player by index. +
diff --git a/docs/libraries/Players/FindByName.md b/docs/libraries/Players/FindByName.md new file mode 100644 index 0000000000..ca61d2460f --- /dev/null +++ b/docs/libraries/Players/FindByName.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: FindByName +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: FindByName + realm: shared + description: "Get a player by name." + + arguments: + - name: "name" + type: string + returns: + - type: Player + description: "The player." +--- + +
+Players.FindByName – Get a player by name. +
diff --git a/docs/libraries/Players/FindBySteamId.md b/docs/libraries/Players/FindBySteamId.md new file mode 100644 index 0000000000..c47273ecb8 --- /dev/null +++ b/docs/libraries/Players/FindBySteamId.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: FindBySteamId +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: FindBySteamId + realm: shared + description: "Get a player by Steam ID." + + arguments: + - name: "Steam ID" + type: string + returns: + - type: Player + description: "The player." +--- + +
+Players.FindBySteamId – Get a player by Steam ID. +
diff --git a/docs/libraries/Players/FindBySteamId64.md b/docs/libraries/Players/FindBySteamId64.md new file mode 100644 index 0000000000..fc6254c7a1 --- /dev/null +++ b/docs/libraries/Players/FindBySteamId64.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: FindBySteamId64 +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: FindBySteamId64 + realm: shared + description: "Get a player by Steam ID 64." + + arguments: + - name: "Steam ID 64" + type: string + returns: + - type: Player + description: "The player." +--- + +
+Players.FindBySteamId64 – Get a player by Steam ID 64. +
diff --git a/docs/libraries/Players/FindByUniqueID.md b/docs/libraries/Players/FindByUniqueID.md new file mode 100644 index 0000000000..6737235a09 --- /dev/null +++ b/docs/libraries/Players/FindByUniqueID.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: FindByUniqueID +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: FindByUniqueID + realm: shared + description: "Get a player by unique ID." + + arguments: + - name: "unique ID" + type: string + returns: + - type: Player + description: "The player." +--- + +
+Players.FindByUniqueID – Get a player by unique ID. +
diff --git a/docs/libraries/Players/FindByUserId.md b/docs/libraries/Players/FindByUserId.md new file mode 100644 index 0000000000..483cfe0634 --- /dev/null +++ b/docs/libraries/Players/FindByUserId.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: FindByUserId +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: FindByUserId + realm: shared + description: "Get a player by user ID." + + arguments: + - name: "user ID" + type: number + returns: + - type: Player + description: "The player." +--- + +
+Players.FindByUserId – Get a player by user ID. +
diff --git a/docs/libraries/Players/GetAll.md b/docs/libraries/Players/GetAll.md new file mode 100644 index 0000000000..d1e5398104 --- /dev/null +++ b/docs/libraries/Players/GetAll.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: GetAll +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: GetAll + realm: shared + description: "Get all players." + + + returns: + - type: table + description: "All players." +--- + +
+Players.GetAll – Get all players. +
diff --git a/docs/libraries/Players/GetAllBots.md b/docs/libraries/Players/GetAllBots.md new file mode 100644 index 0000000000..d7ef8b3052 --- /dev/null +++ b/docs/libraries/Players/GetAllBots.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: GetAllBots +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: GetAllBots + realm: shared + description: "Get all bots." + + + returns: + - type: table + description: "All bots." +--- + +
+Players.GetAllBots – Get all bots. +
diff --git a/docs/libraries/Players/GetAllHumans.md b/docs/libraries/Players/GetAllHumans.md new file mode 100644 index 0000000000..15deadc09f --- /dev/null +++ b/docs/libraries/Players/GetAllHumans.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: GetAllHumans +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: GetAllHumans + realm: shared + description: "Get all humans." + + + returns: + - type: table + description: "All humans." +--- + +
+Players.GetAllHumans – Get all humans. +
diff --git a/docs/libraries/Players/GetLocalPlayerIndex.md b/docs/libraries/Players/GetLocalPlayerIndex.md new file mode 100644 index 0000000000..b4229bbdbe --- /dev/null +++ b/docs/libraries/Players/GetLocalPlayerIndex.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: GetLocalPlayerIndex +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: GetLocalPlayerIndex + realm: shared + description: "Get local player index" + + + returns: + - type: integer + description: "Local player index." +--- + +
+Players.GetLocalPlayerIndex – Get local player index +
diff --git a/docs/libraries/Players/GetLocalPlayerTeam.md b/docs/libraries/Players/GetLocalPlayerTeam.md new file mode 100644 index 0000000000..a3ff73e156 --- /dev/null +++ b/docs/libraries/Players/GetLocalPlayerTeam.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: GetLocalPlayerTeam +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: GetLocalPlayerTeam + realm: shared + description: "Get the team of the local player" + + + returns: + - type: integer + description: "Team of the local player." +--- + +
+Players.GetLocalPlayerTeam – Get the team of the local player +
diff --git a/docs/libraries/Players/GetPlayerConnectionInfo.md b/docs/libraries/Players/GetPlayerConnectionInfo.md new file mode 100644 index 0000000000..219f119814 --- /dev/null +++ b/docs/libraries/Players/GetPlayerConnectionInfo.md @@ -0,0 +1,28 @@ +--- +template: lua-library-function.html +title: GetPlayerConnectionInfo +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: GetPlayerConnectionInfo + realm: shared + description: "Get the connection info of a player." + + arguments: + - name: "index" + type: integer + returns: + - type: integer + description: "The player's ping." + - type: integer + description: "The player's packet loss." +--- + +
+Players.GetPlayerConnectionInfo – Get the connection info of a player. +
diff --git a/docs/libraries/Players/GetSpectatorMode.md b/docs/libraries/Players/GetSpectatorMode.md new file mode 100644 index 0000000000..1aa0ec2d8d --- /dev/null +++ b/docs/libraries/Players/GetSpectatorMode.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: GetSpectatorMode +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: GetSpectatorMode + realm: shared + description: "Get spectator mode of the local player" + + + returns: + - type: integer + description: "Spectator mode of the local player." +--- + +
+Players.GetSpectatorMode – Get spectator mode of the local player +
diff --git a/docs/libraries/Players/GetSpectatorTarget.md b/docs/libraries/Players/GetSpectatorTarget.md new file mode 100644 index 0000000000..c8eb586354 --- /dev/null +++ b/docs/libraries/Players/GetSpectatorTarget.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: GetSpectatorTarget +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: GetSpectatorTarget + realm: shared + description: "Get the spectator target of the local player" + + + returns: + - type: integer + description: "Spectator target of the local player." +--- + +
+Players.GetSpectatorTarget – Get the spectator target of the local player +
diff --git a/docs/libraries/Players/IsLocalPlayerSpectator.md b/docs/libraries/Players/IsLocalPlayerSpectator.md new file mode 100644 index 0000000000..61ca19a54d --- /dev/null +++ b/docs/libraries/Players/IsLocalPlayerSpectator.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: IsLocalPlayerSpectator +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: IsLocalPlayerSpectator + realm: shared + description: "Check if local player is a spectator" + + + returns: + - type: boolean + description: "True if local player is a spectator." +--- + +
+Players.IsLocalPlayerSpectator – Check if local player is a spectator +
diff --git a/docs/libraries/Players/IsPlayerIndex.md b/docs/libraries/Players/IsPlayerIndex.md new file mode 100644 index 0000000000..617680a642 --- /dev/null +++ b/docs/libraries/Players/IsPlayerIndex.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: IsPlayerIndex +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: IsPlayerIndex + realm: shared + description: "Check if index is a player index" + + arguments: + - name: "index" + type: number + returns: + - type: boolean + description: "True if player index, false otherwise." +--- + +
+Players.IsPlayerIndex – Check if index is a player index +
diff --git a/docs/libraries/Players/IsTeamEqual.md b/docs/libraries/Players/IsTeamEqual.md new file mode 100644 index 0000000000..ea22823790 --- /dev/null +++ b/docs/libraries/Players/IsTeamEqual.md @@ -0,0 +1,28 @@ +--- +template: lua-library-function.html +title: IsTeamEqual +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: IsTeamEqual + realm: shared + description: "Check if two teams are equal." + + arguments: + - name: "team 1" + type: string + - name: "team 2" + type: string + returns: + - type: boolean + description: "Whether the teams are equal." +--- + +
+Players.IsTeamEqual – Check if two teams are equal. +
diff --git a/docs/libraries/Players/SayTextToAll.md b/docs/libraries/Players/SayTextToAll.md new file mode 100644 index 0000000000..dd6e267270 --- /dev/null +++ b/docs/libraries/Players/SayTextToAll.md @@ -0,0 +1,31 @@ +--- +template: lua-library-function.html +title: SayTextToAll +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: SayTextToAll + realm: shared + description: "Say text to all players." + + arguments: + - name: "text" + type: string + - name: "speakingPlayer" + type: Player + default: "0" + - name: "withoutStringLookup" + type: boolean + default: "true" + returns: + +--- + +
+Players.SayTextToAll – Say text to all players. +
diff --git a/docs/libraries/Players/ShowMessageToAll.md b/docs/libraries/Players/ShowMessageToAll.md new file mode 100644 index 0000000000..5c47472ad4 --- /dev/null +++ b/docs/libraries/Players/ShowMessageToAll.md @@ -0,0 +1,25 @@ +--- +template: lua-library-function.html +title: ShowMessageToAll +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: ShowMessageToAll + realm: shared + description: "Show a message to all players." + + arguments: + - name: "message" + type: string + returns: + +--- + +
+Players.ShowMessageToAll – Show a message to all players. +
diff --git a/docs/libraries/Players/ViewPunchAll.md b/docs/libraries/Players/ViewPunchAll.md new file mode 100644 index 0000000000..1b5ff339c9 --- /dev/null +++ b/docs/libraries/Players/ViewPunchAll.md @@ -0,0 +1,32 @@ +--- +template: lua-library-function.html +title: ViewPunchAll +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Players + function: ViewPunchAll + realm: shared + description: "Punches the view of all clients within radius. If radius is 0, punches all clients.." + + arguments: + - name: "origin" + type: Vector + - name: "angle" + type: Angle + - name: "radius" + type: number + - name: "shouldPunchPlayersInAir" + type: boolean + default: "false" + returns: + +--- + +
+Players.ViewPunchAll – Punches the view of all clients within radius. If radius is 0, punches all clients.. +
diff --git a/docs/libraries/Randoms/RandomBloodVector.md b/docs/libraries/Randoms/RandomBloodVector.md new file mode 100644 index 0000000000..b0a63982a8 --- /dev/null +++ b/docs/libraries/Randoms/RandomBloodVector.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: RandomBloodVector +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Randoms + function: RandomBloodVector + realm: server + description: "Generate a random blood vector." + + + returns: + - type: Vector + description: "The generated random blood vector." +--- + +
+Randoms.RandomBloodVector – Generate a random blood vector. +
diff --git a/docs/libraries/Randoms/SharedRandomAngle.md b/docs/libraries/Randoms/SharedRandomAngle.md new file mode 100644 index 0000000000..2e450b9448 --- /dev/null +++ b/docs/libraries/Randoms/SharedRandomAngle.md @@ -0,0 +1,33 @@ +--- +template: lua-library-function.html +title: SharedRandomAngle +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Randoms + function: SharedRandomAngle + realm: shared + description: "Generate a shared random angle. Whenever generating random numbers in shared/predicted code, these SharedRandom* functions have to be used. Each call should specify a unique 'sharedName' that seeds the random number generator. In loops make sure the additionalSeed is increased with the loop counter, otherwise it will always return the same random number" + + arguments: + - name: "sharedName" + type: string + - name: "min" + type: number + - name: "max" + type: number + - name: "additionalSeed" + type: number + default: "0" + returns: + - type: Angle + description: "The generated random angle." +--- + +
+Randoms.SharedRandomAngle – Generate a shared random angle. Whenever generating random numbers in shared/predicted code, these SharedRandom* functions have to be used. Each call should specify a unique 'sharedName' that seeds the random number generator. In loops make sure the additionalSeed is increased with the loop counter, otherwise it will always return the same random number +
diff --git a/docs/libraries/Randoms/SharedRandomFloat.md b/docs/libraries/Randoms/SharedRandomFloat.md new file mode 100644 index 0000000000..97e028301e --- /dev/null +++ b/docs/libraries/Randoms/SharedRandomFloat.md @@ -0,0 +1,33 @@ +--- +template: lua-library-function.html +title: SharedRandomFloat +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Randoms + function: SharedRandomFloat + realm: shared + description: "Generate a shared random float. Whenever generating random numbers in shared/predicted code, these SharedRandom* functions have to be used. Each call should specify a unique 'sharedName' that seeds the random number generator. In loops make sure the additionalSeed is increased with the loop counter, otherwise it will always return the same random number" + + arguments: + - name: "sharedName" + type: string + - name: "min" + type: number + - name: "max" + type: number + - name: "additionalSeed" + type: number + default: "0" + returns: + - type: number + description: "The generated random float." +--- + +
+Randoms.SharedRandomFloat – Generate a shared random float. Whenever generating random numbers in shared/predicted code, these SharedRandom* functions have to be used. Each call should specify a unique 'sharedName' that seeds the random number generator. In loops make sure the additionalSeed is increased with the loop counter, otherwise it will always return the same random number +
diff --git a/docs/libraries/Randoms/SharedRandomInt.md b/docs/libraries/Randoms/SharedRandomInt.md new file mode 100644 index 0000000000..6915679cf4 --- /dev/null +++ b/docs/libraries/Randoms/SharedRandomInt.md @@ -0,0 +1,33 @@ +--- +template: lua-library-function.html +title: SharedRandomInt +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Randoms + function: SharedRandomInt + realm: shared + description: "Generate a shared random integer. Whenever generating random numbers in shared/predicted code, these SharedRandom* functions have to be used. Each call should specify a unique 'sharedName' that seeds the random number generator. In loops make sure the additionalSeed is increased with the loop counter, otherwise it will always return the same random number" + + arguments: + - name: "sharedName" + type: string + - name: "min" + type: number + - name: "max" + type: number + - name: "additionalSeed" + type: number + default: "0" + returns: + - type: integer + description: "The generated random integer." +--- + +
+Randoms.SharedRandomInt – Generate a shared random integer. Whenever generating random numbers in shared/predicted code, these SharedRandom* functions have to be used. Each call should specify a unique 'sharedName' that seeds the random number generator. In loops make sure the additionalSeed is increased with the loop counter, otherwise it will always return the same random number +
diff --git a/docs/libraries/Randoms/SharedRandomVector.md b/docs/libraries/Randoms/SharedRandomVector.md new file mode 100644 index 0000000000..86c6b57982 --- /dev/null +++ b/docs/libraries/Randoms/SharedRandomVector.md @@ -0,0 +1,33 @@ +--- +template: lua-library-function.html +title: SharedRandomVector +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Randoms + function: SharedRandomVector + realm: shared + description: "Generate a shared random vector. Whenever generating random numbers in shared/predicted code, these SharedRandom* functions have to be used. Each call should specify a unique 'sharedName' that seeds the random number generator. In loops make sure the additionalSeed is increased with the loop counter, otherwise it will always return the same random number" + + arguments: + - name: "sharedName" + type: string + - name: "min" + type: number + - name: "max" + type: number + - name: "additionalSeed" + type: number + default: "0" + returns: + - type: Vector + description: "The generated random vector." +--- + +
+Randoms.SharedRandomVector – Generate a shared random vector. Whenever generating random numbers in shared/predicted code, these SharedRandom* functions have to be used. Each call should specify a unique 'sharedName' that seeds the random number generator. In loops make sure the additionalSeed is increased with the loop counter, otherwise it will always return the same random number +
diff --git a/docs/libraries/Renders/SpawnBeam.md b/docs/libraries/Renders/SpawnBeam.md new file mode 100644 index 0000000000..47aa569e0d --- /dev/null +++ b/docs/libraries/Renders/SpawnBeam.md @@ -0,0 +1,49 @@ +--- +template: lua-library-function.html +title: SpawnBeam +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Renders + function: SpawnBeam + realm: server + description: "Spawns a temporary beam entity to render a beam. The alpha of the color servers as the brightness of it." + + arguments: + - name: "start" + type: Vector + - name: "end" + type: Vector + - name: "modelIndex" + type: integer + - name: "haloIndex" + type: integer + - name: "frameStart" + type: integer + - name: "frameRate" + type: integer + - name: "life" + type: number + - name: "width" + type: integer + - name: "endWidth" + type: integer + - name: "fadeLength" + type: integer + - name: "noise" + type: integer + - name: "colorAndBrightness" + type: Color + - name: "speed" + type: integer + returns: + +--- + +
+Renders.SpawnBeam – Spawns a temporary beam entity to render a beam. The alpha of the color servers as the brightness of it. +
diff --git a/docs/libraries/Serializers/Base64Decode.md b/docs/libraries/Serializers/Base64Decode.md new file mode 100644 index 0000000000..8bfe9fc3dd --- /dev/null +++ b/docs/libraries/Serializers/Base64Decode.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: Base64Decode +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Serializers + function: Base64Decode + realm: shared + description: "Decode a base64 encoded string" + + arguments: + - name: "string" + type: string + returns: + - type: string + description: "Decoded string." +--- + +
+Serializers.Base64Decode – Decode a base64 encoded string +
diff --git a/docs/libraries/Serializers/Base64Encode.md b/docs/libraries/Serializers/Base64Encode.md new file mode 100644 index 0000000000..93ced748a7 --- /dev/null +++ b/docs/libraries/Serializers/Base64Encode.md @@ -0,0 +1,29 @@ +--- +template: lua-library-function.html +title: Base64Encode +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Serializers + function: Base64Encode + realm: shared + description: "Encode a string to base64" + + arguments: + - name: "string" + type: string + - name: "disableRfc2045Compliance" + type: boolean + default: "false" + returns: + - type: string + description: "Base64 encoded string." +--- + +
+Serializers.Base64Encode – Encode a string to base64 +
diff --git a/docs/libraries/Serializers/Crc32.md b/docs/libraries/Serializers/Crc32.md new file mode 100644 index 0000000000..d5868991a0 --- /dev/null +++ b/docs/libraries/Serializers/Crc32.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: Crc32 +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Serializers + function: Crc32 + realm: shared + description: "Compute the CRC32 of a string" + + arguments: + - name: "string" + type: string + returns: + - type: number + description: "CRC32 of the string." +--- + +
+Serializers.Crc32 – Compute the CRC32 of a string +
diff --git a/docs/libraries/Serializers/JsonEncode.md b/docs/libraries/Serializers/JsonEncode.md new file mode 100644 index 0000000000..242b3dd864 --- /dev/null +++ b/docs/libraries/Serializers/JsonEncode.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: JsonEncode +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Serializers + function: JsonEncode + realm: shared + description: "Encode a lua table to JSON" + + + returns: + - type: string + description: "JSON encoded string." +--- + +
+Serializers.JsonEncode – Encode a lua table to JSON +
diff --git a/docs/libraries/Serializers/index.md b/docs/libraries/Serializers/index.md new file mode 100644 index 0000000000..a9a0fe912f --- /dev/null +++ b/docs/libraries/Serializers/index.md @@ -0,0 +1,10 @@ +--- +template: lua-index.html +childrenTitle: Functions +include: + startsWith: libraries/Serializers/ +exclude: + isIndex: true +--- + +# Serializers diff --git a/docs/libraries/Traces/ClearTrace.md b/docs/libraries/Traces/ClearTrace.md new file mode 100644 index 0000000000..4f06448a3b --- /dev/null +++ b/docs/libraries/Traces/ClearTrace.md @@ -0,0 +1,25 @@ +--- +template: lua-library-function.html +title: ClearTrace +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Traces + function: ClearTrace + realm: server + description: "Clears the given trace object." + + arguments: + - name: "trace" + type: Trace + returns: + +--- + +
+Traces.ClearTrace – Clears the given trace object. +
diff --git a/docs/libraries/Traces/Create.md b/docs/libraries/Traces/Create.md new file mode 100644 index 0000000000..125a8f71a2 --- /dev/null +++ b/docs/libraries/Traces/Create.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: Create +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Traces + function: Create + realm: shared + description: "Create a new trace object." + + + returns: + - type: Trace + description: "The new trace object." +--- + +
+Traces.Create – Create a new trace object. +
diff --git a/docs/libraries/Traces/PointContents.md b/docs/libraries/Traces/PointContents.md new file mode 100644 index 0000000000..e7865470b3 --- /dev/null +++ b/docs/libraries/Traces/PointContents.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: PointContents +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Traces + function: PointContents + realm: shared + description: "Returns the contents mask + entity at a particular world-space position." + + arguments: + - name: "point" + type: Vector + returns: + - type: number + description: "The contents of the point." +--- + +
+Traces.PointContents – Returns the contents mask + entity at a particular world-space position. +
diff --git a/docs/libraries/Traces/TraceEntity.md b/docs/libraries/Traces/TraceEntity.md new file mode 100644 index 0000000000..4c96b9ce27 --- /dev/null +++ b/docs/libraries/Traces/TraceEntity.md @@ -0,0 +1,28 @@ +--- +template: lua-library-function.html +title: TraceEntity +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Traces + function: TraceEntity + realm: shared + description: "Runs a trace using the entity's collisionmodel between two points. This does not take the entity's angles into account and will trace its unrotated collisionmodel." + + arguments: + - name: "entity" + type: Entity + - name: "trace" + type: Trace + returns: + - type: TraceResult + description: "The trace result." +--- + +
+Traces.TraceEntity – Runs a trace using the entity's collisionmodel between two points. This does not take the entity's angles into account and will trace its unrotated collisionmodel. +
diff --git a/docs/libraries/Traces/TraceHull.md b/docs/libraries/Traces/TraceHull.md new file mode 100644 index 0000000000..4ab70c1948 --- /dev/null +++ b/docs/libraries/Traces/TraceHull.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: TraceHull +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Traces + function: TraceHull + realm: shared + description: "Trace a hull." + + arguments: + - name: "trace" + type: Trace + returns: + - type: TraceResult + description: "The trace result." +--- + +
+Traces.TraceHull – Trace a hull. +
diff --git a/docs/libraries/Traces/TraceLine.md b/docs/libraries/Traces/TraceLine.md new file mode 100644 index 0000000000..fe81e9081a --- /dev/null +++ b/docs/libraries/Traces/TraceLine.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: TraceLine +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Traces + function: TraceLine + realm: shared + description: "Trace a line." + + arguments: + - name: "trace" + type: Trace + returns: + - type: TraceResult + description: "The trace result." +--- + +
+Traces.TraceLine – Trace a line. +
diff --git a/docs/libraries/Traces/TraceModel.md b/docs/libraries/Traces/TraceModel.md new file mode 100644 index 0000000000..8b537879b2 --- /dev/null +++ b/docs/libraries/Traces/TraceModel.md @@ -0,0 +1,34 @@ +--- +template: lua-library-function.html +title: TraceModel +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Traces + function: TraceModel + realm: shared + description: "Sweeps against a particular model, using collision rules." + + arguments: + - name: "entity" + type: Entity + - name: "start" + type: Vector + - name: "end" + type: Vector + - name: "hullMinimum" + type: Vector + - name: "hullMaximum" + type: Vector + returns: + - type: TraceResult + description: "The trace result." +--- + +
+Traces.TraceModel – Sweeps against a particular model, using collision rules. +
diff --git a/docs/libraries/Traces/index.md b/docs/libraries/Traces/index.md new file mode 100644 index 0000000000..1144d23717 --- /dev/null +++ b/docs/libraries/Traces/index.md @@ -0,0 +1,10 @@ +--- +template: lua-index.html +childrenTitle: Functions +include: + startsWith: libraries/Traces/ +exclude: + isIndex: true +--- + +# Traces diff --git a/docs/libraries/UserMessages/MessageEnd.md b/docs/libraries/UserMessages/MessageEnd.md index ac3c7aebf0..9073df33be 100644 --- a/docs/libraries/UserMessages/MessageEnd.md +++ b/docs/libraries/UserMessages/MessageEnd.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: MessageEnd -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: MessageEnd - realm: shared + realm: server description: "Ends a user message." diff --git a/docs/libraries/UserMessages/Start.md b/docs/libraries/UserMessages/Start.md index fd71d721a7..7278ce1f49 100644 --- a/docs/libraries/UserMessages/Start.md +++ b/docs/libraries/UserMessages/Start.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: Start -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: Start - realm: shared + realm: server description: "Starts a user message." arguments: diff --git a/docs/libraries/UserMessages/WriteAngle.md b/docs/libraries/UserMessages/WriteAngle.md index b947d811f7..074517e010 100644 --- a/docs/libraries/UserMessages/WriteAngle.md +++ b/docs/libraries/UserMessages/WriteAngle.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: WriteAngle -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: WriteAngle - realm: shared + realm: server description: "Writes an angle." arguments: diff --git a/docs/libraries/UserMessages/WriteBool.md b/docs/libraries/UserMessages/WriteBool.md index 977e2badf6..977da37db9 100644 --- a/docs/libraries/UserMessages/WriteBool.md +++ b/docs/libraries/UserMessages/WriteBool.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: WriteBool -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: WriteBool - realm: shared + realm: server description: "Writes a boolean." arguments: diff --git a/docs/libraries/UserMessages/WriteByte.md b/docs/libraries/UserMessages/WriteByte.md index 2921f769bb..e6fbf84026 100644 --- a/docs/libraries/UserMessages/WriteByte.md +++ b/docs/libraries/UserMessages/WriteByte.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: WriteByte -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: WriteByte - realm: shared + realm: server description: "Writes a byte." arguments: diff --git a/docs/libraries/UserMessages/WriteChar.md b/docs/libraries/UserMessages/WriteChar.md index 09c1c5c183..237f75a9e5 100644 --- a/docs/libraries/UserMessages/WriteChar.md +++ b/docs/libraries/UserMessages/WriteChar.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: WriteChar -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: WriteChar - realm: shared + realm: server description: "Writes a char." arguments: diff --git a/docs/libraries/UserMessages/WriteEntity.md b/docs/libraries/UserMessages/WriteEntity.md index 94e2a95b0c..edc03b11b0 100644 --- a/docs/libraries/UserMessages/WriteEntity.md +++ b/docs/libraries/UserMessages/WriteEntity.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: WriteEntity -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: WriteEntity - realm: shared + realm: server description: "Writes an entity." argumentSets: diff --git a/docs/libraries/UserMessages/WriteFloat.md b/docs/libraries/UserMessages/WriteFloat.md index f1f068b4a9..9580e60937 100644 --- a/docs/libraries/UserMessages/WriteFloat.md +++ b/docs/libraries/UserMessages/WriteFloat.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: WriteFloat -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: WriteFloat - realm: shared + realm: server description: "Writes a float." arguments: diff --git a/docs/libraries/UserMessages/WriteLong.md b/docs/libraries/UserMessages/WriteLong.md index 0c8fedaaeb..7df7ef7911 100644 --- a/docs/libraries/UserMessages/WriteLong.md +++ b/docs/libraries/UserMessages/WriteLong.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: WriteLong -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: WriteLong - realm: shared + realm: server description: "Writes a long integer." arguments: diff --git a/docs/libraries/UserMessages/WriteNormal.md b/docs/libraries/UserMessages/WriteNormal.md index f9ee2d2068..cf9bbe0144 100644 --- a/docs/libraries/UserMessages/WriteNormal.md +++ b/docs/libraries/UserMessages/WriteNormal.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: WriteNormal -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: WriteNormal - realm: shared + realm: server description: "Writes a normal vector." arguments: diff --git a/docs/libraries/UserMessages/WriteSBitLong.md b/docs/libraries/UserMessages/WriteSBitLong.md index 7b72bb437b..d4681fb131 100644 --- a/docs/libraries/UserMessages/WriteSBitLong.md +++ b/docs/libraries/UserMessages/WriteSBitLong.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: WriteSBitLong -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: WriteSBitLong - realm: shared + realm: server description: "Writes a signed bit long." arguments: diff --git a/docs/libraries/UserMessages/WriteShort.md b/docs/libraries/UserMessages/WriteShort.md index 0d0a168a2d..4335ba9388 100644 --- a/docs/libraries/UserMessages/WriteShort.md +++ b/docs/libraries/UserMessages/WriteShort.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: WriteShort -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: WriteShort - realm: shared + realm: server description: "Writes a short integer." arguments: diff --git a/docs/libraries/UserMessages/WriteString.md b/docs/libraries/UserMessages/WriteString.md index e455fe41a2..3e6935b877 100644 --- a/docs/libraries/UserMessages/WriteString.md +++ b/docs/libraries/UserMessages/WriteString.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: WriteString -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: WriteString - realm: shared + realm: server description: "Writes a string." arguments: diff --git a/docs/libraries/UserMessages/WriteUBitLong.md b/docs/libraries/UserMessages/WriteUBitLong.md index 7f2624000f..9b35e1a7a4 100644 --- a/docs/libraries/UserMessages/WriteUBitLong.md +++ b/docs/libraries/UserMessages/WriteUBitLong.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: WriteUBitLong -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: WriteUBitLong - realm: shared + realm: server description: "Writes an unsigned bit long." arguments: diff --git a/docs/libraries/UserMessages/WriteVector.md b/docs/libraries/UserMessages/WriteVector.md index 8bf51938c3..84406cad92 100644 --- a/docs/libraries/UserMessages/WriteVector.md +++ b/docs/libraries/UserMessages/WriteVector.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: WriteVector -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: WriteVector - realm: shared + realm: server description: "Writes a vector." arguments: diff --git a/docs/libraries/UserMessages/WriteWord.md b/docs/libraries/UserMessages/WriteWord.md index 8e923fbb76..e1861d0db2 100644 --- a/docs/libraries/UserMessages/WriteWord.md +++ b/docs/libraries/UserMessages/WriteWord.md @@ -1,16 +1,16 @@ --- template: lua-library-function.html title: WriteWord -icon: lua-shared +icon: lua-server tags: - lua - - shared + - server - needs-verification - needs-example lua: library: UserMessages function: WriteWord - realm: shared + realm: server description: "Writes a word." arguments: diff --git a/docs/libraries/Utilities/AngleDifference.md b/docs/libraries/Utilities/AngleDifference.md new file mode 100644 index 0000000000..1577359c11 --- /dev/null +++ b/docs/libraries/Utilities/AngleDifference.md @@ -0,0 +1,28 @@ +--- +template: lua-library-function.html +title: AngleDifference +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: AngleDifference + realm: shared + description: "Compute the difference between two angles" + + arguments: + - name: "srcAngle" + type: number + - name: "dstAngle" + type: number + returns: + - type: number + description: "Difference between the angles." +--- + +
+Utilities.AngleDifference – Compute the difference between two angles +
diff --git a/docs/libraries/Utilities/BoundToWorldSize.md b/docs/libraries/Utilities/BoundToWorldSize.md new file mode 100644 index 0000000000..e2e719ad8f --- /dev/null +++ b/docs/libraries/Utilities/BoundToWorldSize.md @@ -0,0 +1,25 @@ +--- +template: lua-library-function.html +title: BoundToWorldSize +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: BoundToWorldSize + realm: shared + description: "Bound the vector to the world size" + + arguments: + - name: "vec" + type: Vector + returns: + +--- + +
+Utilities.BoundToWorldSize – Bound the vector to the world size +
diff --git a/docs/libraries/Utilities/ClientPrint.md b/docs/libraries/Utilities/ClientPrint.md new file mode 100644 index 0000000000..0b5562bab4 --- /dev/null +++ b/docs/libraries/Utilities/ClientPrint.md @@ -0,0 +1,41 @@ +--- +template: lua-library-function.html +title: ClientPrint +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: ClientPrint + realm: shared + description: "Print message to client" + + arguments: + - name: "player" + type: Player + - name: "msgDest" + type: number + - name: "message" + type: string + - name: "param1" + type: string + default: "0" + - name: "param2" + type: string + default: "0" + - name: "param3" + type: string + default: "0" + - name: "param4" + type: string + default: "0" + returns: + +--- + +
+Utilities.ClientPrint – Print message to client +
diff --git a/docs/libraries/Utilities/ComputeStringWidth.md b/docs/libraries/Utilities/ComputeStringWidth.md new file mode 100644 index 0000000000..f1b9c0f253 --- /dev/null +++ b/docs/libraries/Utilities/ComputeStringWidth.md @@ -0,0 +1,28 @@ +--- +template: lua-library-function.html +title: ComputeStringWidth +icon: lua-client +tags: + - lua + - client + - needs-verification + - needs-example +lua: + library: Utilities + function: ComputeStringWidth + realm: client + description: "Compute width of the string with the given font" + + arguments: + - name: "font" + type: FontHandle + - name: "text" + type: string + returns: + - type: integer + description: "Width of the string." +--- + +
+Utilities.ComputeStringWidth – Compute width of the string with the given font +
diff --git a/docs/libraries/Utilities/CreateBubbles.md b/docs/libraries/Utilities/CreateBubbles.md new file mode 100644 index 0000000000..36eef5f314 --- /dev/null +++ b/docs/libraries/Utilities/CreateBubbles.md @@ -0,0 +1,29 @@ +--- +template: lua-library-function.html +title: CreateBubbles +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: CreateBubbles + realm: shared + description: "Create bubbles at the specified position and range" + + arguments: + - name: "minPos" + type: Vector + - name: "maxPos" + type: Vector + - name: "count" + type: number + returns: + +--- + +
+Utilities.CreateBubbles – Create bubbles at the specified position and range +
diff --git a/docs/libraries/Utilities/CreateSmoke.md b/docs/libraries/Utilities/CreateSmoke.md new file mode 100644 index 0000000000..bb06d2f764 --- /dev/null +++ b/docs/libraries/Utilities/CreateSmoke.md @@ -0,0 +1,29 @@ +--- +template: lua-library-function.html +title: CreateSmoke +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: CreateSmoke + realm: shared + description: "Create smoke effect at a position" + + arguments: + - name: "position" + type: Vector + - name: "modelIndex" + type: number + - name: "scale" + type: number + returns: + +--- + +
+Utilities.CreateSmoke – Create smoke effect at a position +
diff --git a/docs/libraries/Utilities/CreateTracer.md b/docs/libraries/Utilities/CreateTracer.md new file mode 100644 index 0000000000..e219e4f9d6 --- /dev/null +++ b/docs/libraries/Utilities/CreateTracer.md @@ -0,0 +1,37 @@ +--- +template: lua-library-function.html +title: CreateTracer +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: CreateTracer + realm: shared + description: "Create a tracer from the specified start to end position" + + arguments: + - name: "startPos" + type: Vector + - name: "endPos" + type: Vector + - name: "life" + type: number + - name: "width" + type: number + - name: "brightness" + type: number + - name: "noise" + type: boolean + - name: "modelname" + type: string + returns: + +--- + +
+Utilities.CreateTracer – Create a tracer from the specified start to end position +
diff --git a/docs/libraries/Utilities/FindWaterSurface.md b/docs/libraries/Utilities/FindWaterSurface.md new file mode 100644 index 0000000000..7171eff19c --- /dev/null +++ b/docs/libraries/Utilities/FindWaterSurface.md @@ -0,0 +1,30 @@ +--- +template: lua-library-function.html +title: FindWaterSurface +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Utilities + function: FindWaterSurface + realm: server + description: "Finds the water surface at the given position." + + arguments: + - name: "position" + type: Vector + - name: "minZ" + type: number + - name: "maxZ" + type: number + returns: + - type: number + description: "The water surface z position." +--- + +
+Utilities.FindWaterSurface – Finds the water surface at the given position. +
diff --git a/docs/libraries/Utilities/GetLocalPlayer.md b/docs/libraries/Utilities/GetLocalPlayer.md new file mode 100644 index 0000000000..5fbc86ffed --- /dev/null +++ b/docs/libraries/Utilities/GetLocalPlayer.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: GetLocalPlayer +icon: lua-client +tags: + - lua + - client + - needs-verification + - needs-example +lua: + library: Utilities + function: GetLocalPlayer + realm: client + description: "Get the local player entity" + + + returns: + - type: Entity + description: "Local player entity." +--- + +
+Utilities.GetLocalPlayer – Get the local player entity +
diff --git a/docs/libraries/Utilities/GetPointWaterLevel.md b/docs/libraries/Utilities/GetPointWaterLevel.md new file mode 100644 index 0000000000..caae4e82c8 --- /dev/null +++ b/docs/libraries/Utilities/GetPointWaterLevel.md @@ -0,0 +1,30 @@ +--- +template: lua-library-function.html +title: GetPointWaterLevel +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: GetPointWaterLevel + realm: shared + description: "Get the water level at the specified position" + + arguments: + - name: "point" + type: Vector + - name: "minz" + type: number + - name: "maxz" + type: number + returns: + - type: number + description: "Water level at the specified position" +--- + +
+Utilities.GetPointWaterLevel – Get the water level at the specified position +
diff --git a/docs/libraries/Utilities/GetScreenHeight.md b/docs/libraries/Utilities/GetScreenHeight.md new file mode 100644 index 0000000000..74b476ea3f --- /dev/null +++ b/docs/libraries/Utilities/GetScreenHeight.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: GetScreenHeight +icon: lua-client +tags: + - lua + - client + - needs-verification + - needs-example +lua: + library: Utilities + function: GetScreenHeight + realm: client + description: "Get screen height" + + + returns: + - type: integer + description: "Screen height." +--- + +
+Utilities.GetScreenHeight – Get screen height +
diff --git a/docs/libraries/Utilities/GetScreenWidth.md b/docs/libraries/Utilities/GetScreenWidth.md new file mode 100644 index 0000000000..1de67f489c --- /dev/null +++ b/docs/libraries/Utilities/GetScreenWidth.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: GetScreenWidth +icon: lua-client +tags: + - lua + - client + - needs-verification + - needs-example +lua: + library: Utilities + function: GetScreenWidth + realm: client + description: "Get screen width" + + + returns: + - type: integer + description: "Screen width." +--- + +
+Utilities.GetScreenWidth – Get screen width +
diff --git a/docs/libraries/Utilities/ImpactTrace.md b/docs/libraries/Utilities/ImpactTrace.md new file mode 100644 index 0000000000..9c192bd3d6 --- /dev/null +++ b/docs/libraries/Utilities/ImpactTrace.md @@ -0,0 +1,30 @@ +--- +template: lua-library-function.html +title: ImpactTrace +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: ImpactTrace + realm: shared + description: "Generate an impact trace" + + arguments: + - name: "trace" + type: Trace + - name: "damageType" + type: number + - name: "customImpactName" + type: string + default: "0" + returns: + +--- + +
+Utilities.ImpactTrace – Generate an impact trace +
diff --git a/docs/libraries/Utilities/InterpolateAngles.md b/docs/libraries/Utilities/InterpolateAngles.md new file mode 100644 index 0000000000..43bbae65fd --- /dev/null +++ b/docs/libraries/Utilities/InterpolateAngles.md @@ -0,0 +1,31 @@ +--- +template: lua-library-function.html +title: InterpolateAngles +icon: lua-client +tags: + - lua + - client + - needs-verification + - needs-example +lua: + library: Utilities + function: InterpolateAngles + realm: client + description: "Interpolate between angles based on the provided fraction" + + arguments: + - name: "startAngles" + type: Angle + - name: "endAngles" + type: Angle + - name: "resultAngles" + type: Angle + - name: "fraction" + type: number + returns: + +--- + +
+Utilities.InterpolateAngles – Interpolate between angles based on the provided fraction +
diff --git a/docs/libraries/Utilities/IntersectRayWithObb.md b/docs/libraries/Utilities/IntersectRayWithObb.md new file mode 100644 index 0000000000..48f4466267 --- /dev/null +++ b/docs/libraries/Utilities/IntersectRayWithObb.md @@ -0,0 +1,40 @@ +--- +template: lua-library-function.html +title: IntersectRayWithObb +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: IntersectRayWithObb + realm: shared + description: "Intersect a ray with an oriented bounding box" + + arguments: + - name: "vecRayStart" + type: Vector + - name: "vecRayDelta" + type: Vector + - name: "vecBoxOrigin" + type: Vector + - name: "angBoxAngles" + type: Angle + - name: "vecBoxMins" + type: Vector + - name: "vecBoxMaxs" + type: Vector + returns: + - type: Vector + description: "End position of the intersection" + - type: Vector + description: "Normal of the intersection" + - type: number + description: "Fraction of the intersection" +--- + +
+Utilities.IntersectRayWithObb – Intersect a ray with an oriented bounding box +
diff --git a/docs/libraries/Utilities/IntersectRayWithPlane.md b/docs/libraries/Utilities/IntersectRayWithPlane.md new file mode 100644 index 0000000000..df9c1e878d --- /dev/null +++ b/docs/libraries/Utilities/IntersectRayWithPlane.md @@ -0,0 +1,32 @@ +--- +template: lua-library-function.html +title: IntersectRayWithPlane +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: IntersectRayWithPlane + realm: shared + description: "Intersect a ray with a plane" + + arguments: + - name: "vecRayOrigin" + type: Vector + - name: "vecRayDirection" + type: Vector + - name: "vecPlaneOrigin" + type: Vector + - name: "vecPlaneNormal" + type: Vector + returns: + - type: Vector + description: "Intersection position" +--- + +
+Utilities.IntersectRayWithPlane – Intersect a ray with a plane +
diff --git a/docs/libraries/Utilities/IntersectRayWithSphere.md b/docs/libraries/Utilities/IntersectRayWithSphere.md new file mode 100644 index 0000000000..ea39e8c09d --- /dev/null +++ b/docs/libraries/Utilities/IntersectRayWithSphere.md @@ -0,0 +1,34 @@ +--- +template: lua-library-function.html +title: IntersectRayWithSphere +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: IntersectRayWithSphere + realm: shared + description: "Intersect a ray with a sphere" + + arguments: + - name: "vecRayOrigin" + type: Vector + - name: "vecRayDelta" + type: Vector + - name: "vecSphereCenter" + type: Vector + - name: "flRadius" + type: number + returns: + - type: number + description: "First intersection point" + - type: number + description: "Second intersection point" +--- + +
+Utilities.IntersectRayWithSphere – Intersect a ray with a sphere +
diff --git a/docs/libraries/Utilities/IsBoxIntersectingSphere.md b/docs/libraries/Utilities/IsBoxIntersectingSphere.md new file mode 100644 index 0000000000..7fe9773dc4 --- /dev/null +++ b/docs/libraries/Utilities/IsBoxIntersectingSphere.md @@ -0,0 +1,32 @@ +--- +template: lua-library-function.html +title: IsBoxIntersectingSphere +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: IsBoxIntersectingSphere + realm: shared + description: "Check if a box is intersecting a sphere" + + arguments: + - name: "boxMin" + type: Vector + - name: "boxMax" + type: Vector + - name: "spherePosition" + type: Vector + - name: "sphereRadius" + type: number + returns: + - type: boolean + description: "True if the box is intersecting the sphere" +--- + +
+Utilities.IsBoxIntersectingSphere – Check if a box is intersecting a sphere +
diff --git a/docs/libraries/Utilities/IsLowViolence.md b/docs/libraries/Utilities/IsLowViolence.md new file mode 100644 index 0000000000..d55a44a052 --- /dev/null +++ b/docs/libraries/Utilities/IsLowViolence.md @@ -0,0 +1,24 @@ +--- +template: lua-library-function.html +title: IsLowViolence +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: IsLowViolence + realm: shared + description: "Check if the game is in low violence mode" + + + returns: + - type: boolean + description: "True if the game is in low violence mode" +--- + +
+Utilities.IsLowViolence – Check if the game is in low violence mode +
diff --git a/docs/libraries/Utilities/IsObbIntersectingObb.md b/docs/libraries/Utilities/IsObbIntersectingObb.md new file mode 100644 index 0000000000..02094d11a9 --- /dev/null +++ b/docs/libraries/Utilities/IsObbIntersectingObb.md @@ -0,0 +1,43 @@ +--- +template: lua-library-function.html +title: IsObbIntersectingObb +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: IsObbIntersectingObb + realm: shared + description: "Check if an oriented bounding box is intersecting another oriented bounding box" + + arguments: + - name: "vecOrigin1" + type: Vector + - name: "vecAngles1" + type: Angle + - name: "boxMin1" + type: Vector + - name: "boxMax1" + type: Vector + - name: "vecOrigin2" + type: Vector + - name: "vecAngles2" + type: Angle + - name: "boxMin2" + type: Vector + - name: "boxMax2" + type: Vector + - name: "flTolerance" + type: number + default: "0.0f" + returns: + - type: boolean + description: "True if the oriented bounding boxes are intersecting" +--- + +
+Utilities.IsObbIntersectingObb – Check if an oriented bounding box is intersecting another oriented bounding box +
diff --git a/docs/libraries/Utilities/IsSpaceEmpty.md b/docs/libraries/Utilities/IsSpaceEmpty.md new file mode 100644 index 0000000000..fc099ecc44 --- /dev/null +++ b/docs/libraries/Utilities/IsSpaceEmpty.md @@ -0,0 +1,30 @@ +--- +template: lua-library-function.html +title: IsSpaceEmpty +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: IsSpaceEmpty + realm: shared + description: "Check if the space is empty" + + arguments: + - name: "entity" + type: Entity + - name: "minPos" + type: Vector + - name: "maxPos" + type: Vector + returns: + - type: boolean + description: "True if the space is empty" +--- + +
+Utilities.IsSpaceEmpty – Check if the space is empty +
diff --git a/docs/libraries/Utilities/IsSphereIntersectingCone.md b/docs/libraries/Utilities/IsSphereIntersectingCone.md new file mode 100644 index 0000000000..866aa96f94 --- /dev/null +++ b/docs/libraries/Utilities/IsSphereIntersectingCone.md @@ -0,0 +1,36 @@ +--- +template: lua-library-function.html +title: IsSphereIntersectingCone +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: IsSphereIntersectingCone + realm: shared + description: "Check if a sphere is intersecting a cone" + + arguments: + - name: "sphereCenter" + type: Vector + - name: "sphereRadius" + type: number + - name: "coneOrigin" + type: Vector + - name: "coneAxis" + type: Vector + - name: "coneSine" + type: number + - name: "coneCosine" + type: number + returns: + - type: boolean + description: "True if the sphere is intersecting the cone" +--- + +
+Utilities.IsSphereIntersectingCone – Check if a sphere is intersecting a cone +
diff --git a/docs/libraries/Utilities/IsSphereIntersectingSphere.md b/docs/libraries/Utilities/IsSphereIntersectingSphere.md new file mode 100644 index 0000000000..6a156245be --- /dev/null +++ b/docs/libraries/Utilities/IsSphereIntersectingSphere.md @@ -0,0 +1,32 @@ +--- +template: lua-library-function.html +title: IsSphereIntersectingSphere +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: IsSphereIntersectingSphere + realm: shared + description: "Check if a sphere is intersecting another sphere" + + arguments: + - name: "sphereCenter1" + type: Vector + - name: "sphereRadius1" + type: number + - name: "sphereCenter2" + type: Vector + - name: "sphereRadius2" + type: number + returns: + - type: boolean + description: "True if the spheres are intersecting" +--- + +
+Utilities.IsSphereIntersectingSphere – Check if a sphere is intersecting another sphere +
diff --git a/docs/libraries/Utilities/IsValidModel.md b/docs/libraries/Utilities/IsValidModel.md new file mode 100644 index 0000000000..6dbd7e1ebc --- /dev/null +++ b/docs/libraries/Utilities/IsValidModel.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: IsValidModel +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: IsValidModel + realm: shared + description: "Check if the given string is a valid model" + + arguments: + - name: "model" + type: string + returns: + - type: boolean + description: "True if the model is valid" +--- + +
+Utilities.IsValidModel – Check if the given string is a valid model +
diff --git a/docs/libraries/Utilities/IsValidPhysicsProp.md b/docs/libraries/Utilities/IsValidPhysicsProp.md new file mode 100644 index 0000000000..98bbee9c02 --- /dev/null +++ b/docs/libraries/Utilities/IsValidPhysicsProp.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: IsValidPhysicsProp +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: IsValidPhysicsProp + realm: shared + description: "Check if the given string is a valid physics props" + + arguments: + - name: "model" + type: string + returns: + - type: boolean + description: "True if the model is a valid physics prop" +--- + +
+Utilities.IsValidPhysicsProp – Check if the given string is a valid physics props +
diff --git a/docs/libraries/Utilities/NormalizeAngles.md b/docs/libraries/Utilities/NormalizeAngles.md new file mode 100644 index 0000000000..14747522f5 --- /dev/null +++ b/docs/libraries/Utilities/NormalizeAngles.md @@ -0,0 +1,25 @@ +--- +template: lua-library-function.html +title: NormalizeAngles +icon: lua-client +tags: + - lua + - client + - needs-verification + - needs-example +lua: + library: Utilities + function: NormalizeAngles + realm: client + description: "Normalize angles provided" + + arguments: + - name: "angles" + type: Angle + returns: + +--- + +
+Utilities.NormalizeAngles – Normalize angles provided +
diff --git a/docs/libraries/Utilities/PointOnLineNearestPoint.md b/docs/libraries/Utilities/PointOnLineNearestPoint.md new file mode 100644 index 0000000000..c739835bc1 --- /dev/null +++ b/docs/libraries/Utilities/PointOnLineNearestPoint.md @@ -0,0 +1,33 @@ +--- +template: lua-library-function.html +title: PointOnLineNearestPoint +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: PointOnLineNearestPoint + realm: shared + description: "Returns the nearest point on a line to a given point." + + arguments: + - name: "point" + type: Vector + - name: "lineStart" + type: Vector + - name: "lineEnd" + type: Vector + - name: "clamp" + type: boolean + default: "false" + returns: + - type: vector + description: "The nearest point on the line." +--- + +
+Utilities.PointOnLineNearestPoint – Returns the nearest point on a line to a given point. +
diff --git a/docs/libraries/Utilities/PrecacheDecal.md b/docs/libraries/Utilities/PrecacheDecal.md new file mode 100644 index 0000000000..e6c50e10cf --- /dev/null +++ b/docs/libraries/Utilities/PrecacheDecal.md @@ -0,0 +1,29 @@ +--- +template: lua-library-function.html +title: PrecacheDecal +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Utilities + function: PrecacheDecal + realm: server + description: "Precaches a decal. If preload is specified, the file is loaded into the server/client's cache memory before level startup, otherwise it'll only load when actually used (which can cause a disk i/o hitch if it occurs during play of a level)." + + arguments: + - name: "name" + type: string + - name: "shouldPreload" + type: boolean + default: "false" + returns: + - type: number + description: "The decal index." +--- + +
+Utilities.PrecacheDecal – Precaches a decal. If preload is specified, the file is loaded into the server/client's cache memory before level startup, otherwise it'll only load when actually used (which can cause a disk i/o hitch if it occurs during play of a level). +
diff --git a/docs/libraries/Utilities/PrecacheOther.md b/docs/libraries/Utilities/PrecacheOther.md new file mode 100644 index 0000000000..4d6b6a99fc --- /dev/null +++ b/docs/libraries/Utilities/PrecacheOther.md @@ -0,0 +1,25 @@ +--- +template: lua-library-function.html +title: PrecacheOther +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: PrecacheOther + realm: shared + description: "Precache an entity by class name" + + arguments: + - name: "className" + type: string + returns: + +--- + +
+Utilities.PrecacheOther – Precache an entity by class name +
diff --git a/docs/libraries/Utilities/SafeName.md b/docs/libraries/Utilities/SafeName.md new file mode 100644 index 0000000000..7106f112ce --- /dev/null +++ b/docs/libraries/Utilities/SafeName.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: SafeName +icon: lua-client +tags: + - lua + - client + - needs-verification + - needs-example +lua: + library: Utilities + function: SafeName + realm: client + description: "Get a safe name for the provided string" + + arguments: + - name: "name" + type: string + returns: + - type: string + description: "Safe name." +--- + +
+Utilities.SafeName – Get a safe name for the provided string +
diff --git a/docs/libraries/Utilities/SetEntityOrigin.md b/docs/libraries/Utilities/SetEntityOrigin.md new file mode 100644 index 0000000000..563edc2c6d --- /dev/null +++ b/docs/libraries/Utilities/SetEntityOrigin.md @@ -0,0 +1,27 @@ +--- +template: lua-library-function.html +title: SetEntityOrigin +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: SetEntityOrigin + realm: shared + description: "Set the origin for an entity" + + arguments: + - name: "entity" + type: Entity + - name: "origin" + type: Vector + returns: + +--- + +
+Utilities.SetEntityOrigin – Set the origin for an entity +
diff --git a/docs/libraries/Utilities/ShakeScreen.md b/docs/libraries/Utilities/ShakeScreen.md new file mode 100644 index 0000000000..e265ac4903 --- /dev/null +++ b/docs/libraries/Utilities/ShakeScreen.md @@ -0,0 +1,38 @@ +--- +template: lua-library-function.html +title: ShakeScreen +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: ShakeScreen + realm: shared + description: "Apply screen shake effect" + + arguments: + - name: "center" + type: Vector + - name: "amplitude" + type: number + - name: "frequency" + type: number + - name: "duration" + type: number + - name: "radius" + type: number + - name: "command" + type: number + - name: "localAmplitude" + type: boolean + default: "false" + returns: + +--- + +
+Utilities.ShakeScreen – Apply screen shake effect +
diff --git a/docs/libraries/Utilities/ShouldShowBlood.md b/docs/libraries/Utilities/ShouldShowBlood.md new file mode 100644 index 0000000000..bb5e8046ee --- /dev/null +++ b/docs/libraries/Utilities/ShouldShowBlood.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: ShouldShowBlood +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Utilities + function: ShouldShowBlood + realm: shared + description: "Check if blood of the given color should be shown" + + arguments: + - name: "bloodColor" + type: number + returns: + - type: boolean + description: "True if blood should be shown" +--- + +
+Utilities.ShouldShowBlood – Check if blood of the given color should be shown +
diff --git a/docs/libraries/Utilities/ValidateSoundName.md b/docs/libraries/Utilities/ValidateSoundName.md new file mode 100644 index 0000000000..6fd0aeed84 --- /dev/null +++ b/docs/libraries/Utilities/ValidateSoundName.md @@ -0,0 +1,28 @@ +--- +template: lua-library-function.html +title: ValidateSoundName +icon: lua-server +tags: + - lua + - server + - needs-verification + - needs-example +lua: + library: Utilities + function: ValidateSoundName + realm: server + description: "Validates a sound name." + + arguments: + - name: "name" + type: string + - name: "default" + type: string + returns: + - type: string + description: "The validated sound name." +--- + +
+Utilities.ValidateSoundName – Validates a sound name. +
diff --git a/docs/libraries/Utilities/index.md b/docs/libraries/Utilities/index.md new file mode 100644 index 0000000000..715f70042d --- /dev/null +++ b/docs/libraries/Utilities/index.md @@ -0,0 +1,10 @@ +--- +template: lua-index.html +childrenTitle: Functions +include: + startsWith: libraries/Utilities/ +exclude: + isIndex: true +--- + +# Utilities diff --git a/docs/libraries/Vectors/AxisStringToPointDirection.md b/docs/libraries/Vectors/AxisStringToPointDirection.md new file mode 100644 index 0000000000..5d03823556 --- /dev/null +++ b/docs/libraries/Vectors/AxisStringToPointDirection.md @@ -0,0 +1,28 @@ +--- +template: lua-library-function.html +title: AxisStringToPointDirection +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Vectors + function: AxisStringToPointDirection + realm: shared + description: "Converts an axis string to a point direction." + + arguments: + - name: "axisString" + type: string + returns: + - type: Vector + description: "The converted start point." + - type: vector + description: "The converted direction." +--- + +
+Vectors.AxisStringToPointDirection – Converts an axis string to a point direction. +
diff --git a/docs/libraries/Vectors/AxisStringToPointPoint.md b/docs/libraries/Vectors/AxisStringToPointPoint.md new file mode 100644 index 0000000000..dbf34bc2a4 --- /dev/null +++ b/docs/libraries/Vectors/AxisStringToPointPoint.md @@ -0,0 +1,28 @@ +--- +template: lua-library-function.html +title: AxisStringToPointPoint +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Vectors + function: AxisStringToPointPoint + realm: shared + description: "Converts an axis string to a point point." + + arguments: + - name: "axisString" + type: string + returns: + - type: Vector + description: "The converted start point." + - type: vector + description: "The converted end point." +--- + +
+Vectors.AxisStringToPointPoint – Converts an axis string to a point point. +
diff --git a/docs/libraries/Vectors/AxisStringToUnitDirection.md b/docs/libraries/Vectors/AxisStringToUnitDirection.md new file mode 100644 index 0000000000..775e38185d --- /dev/null +++ b/docs/libraries/Vectors/AxisStringToUnitDirection.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: AxisStringToUnitDirection +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Vectors + function: AxisStringToUnitDirection + realm: shared + description: "Converts an axis string to a unit direction." + + arguments: + - name: "axisString" + type: string + returns: + - type: Vector + description: "The converted unit direction." +--- + +
+Vectors.AxisStringToUnitDirection – Converts an axis string to a unit direction. +
diff --git a/docs/libraries/_G/Vector.md b/docs/libraries/Vectors/Create.md similarity index 84% rename from docs/libraries/_G/Vector.md rename to docs/libraries/Vectors/Create.md index a315d81fed..f3361add5e 100644 --- a/docs/libraries/_G/Vector.md +++ b/docs/libraries/Vectors/Create.md @@ -1,6 +1,6 @@ --- template: lua-library-function.html -title: Vector +title: Create icon: lua-shared tags: - lua @@ -8,8 +8,8 @@ tags: - needs-verification - needs-example lua: - library: _G - function: Vector + library: Vectors + function: Create realm: shared description: "Creates a new vector." @@ -31,10 +31,10 @@ lua: type: number default: "0.0f" returns: - - type: vector + - type: Vector description: "The created vector." ---
-_G.Vector – Creates a new vector. +Vectors.Create – Creates a new vector.
diff --git a/docs/libraries/Vectors/SnapDirectionToAxis.md b/docs/libraries/Vectors/SnapDirectionToAxis.md new file mode 100644 index 0000000000..cea7d0946f --- /dev/null +++ b/docs/libraries/Vectors/SnapDirectionToAxis.md @@ -0,0 +1,28 @@ +--- +template: lua-library-function.html +title: SnapDirectionToAxis +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Vectors + function: SnapDirectionToAxis + realm: shared + description: "Modifies a vector so it snaps to the nearest axis vector (if within epsilon)." + + arguments: + - name: "direction" + type: Vector + - name: "epsilon" + type: number + default: "0.002f" + returns: + +--- + +
+Vectors.SnapDirectionToAxis – Modifies a vector so it snaps to the nearest axis vector (if within epsilon). +
diff --git a/docs/libraries/Vectors/VectorToPitch.md b/docs/libraries/Vectors/VectorToPitch.md new file mode 100644 index 0000000000..e2466b2cf7 --- /dev/null +++ b/docs/libraries/Vectors/VectorToPitch.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: VectorToPitch +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Vectors + function: VectorToPitch + realm: shared + description: "Converts a vector to a pitch angle." + + arguments: + - name: "vector" + type: Vector + returns: + - type: number + description: "The converted pitch angle." +--- + +
+Vectors.VectorToPitch – Converts a vector to a pitch angle. +
diff --git a/docs/libraries/Vectors/VectorToYaw.md b/docs/libraries/Vectors/VectorToYaw.md new file mode 100644 index 0000000000..61296dc2eb --- /dev/null +++ b/docs/libraries/Vectors/VectorToYaw.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: VectorToYaw +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Vectors + function: VectorToYaw + realm: shared + description: "Converts a vector to a yaw angle." + + arguments: + - name: "vector" + type: Vector + returns: + - type: number + description: "The converted yaw angle." +--- + +
+Vectors.VectorToYaw – Converts a vector to a yaw angle. +
diff --git a/docs/libraries/Vectors/YawToVector.md b/docs/libraries/Vectors/YawToVector.md new file mode 100644 index 0000000000..7eb7871b37 --- /dev/null +++ b/docs/libraries/Vectors/YawToVector.md @@ -0,0 +1,26 @@ +--- +template: lua-library-function.html +title: YawToVector +icon: lua-shared +tags: + - lua + - shared + - needs-verification + - needs-example +lua: + library: Vectors + function: YawToVector + realm: shared + description: "Converts a yaw angle to a vector." + + arguments: + - name: "yaw" + type: number + returns: + - type: Vector + description: "The converted vector." +--- + +
+Vectors.YawToVector – Converts a yaw angle to a vector. +
diff --git a/docs/libraries/Vectors/index.md b/docs/libraries/Vectors/index.md new file mode 100644 index 0000000000..259a537036 --- /dev/null +++ b/docs/libraries/Vectors/index.md @@ -0,0 +1,10 @@ +--- +template: lua-index.html +childrenTitle: Functions +include: + startsWith: libraries/Vectors/ +exclude: + isIndex: true +--- + +# Vectors diff --git a/docs/libraries/_G/Angle.md b/docs/libraries/_G/Angle.md index cc47f070bd..8b16769ff6 100644 --- a/docs/libraries/_G/Angle.md +++ b/docs/libraries/_G/Angle.md @@ -31,7 +31,7 @@ lua: type: number default: "0.0f" returns: - - type: angle + - type: Angle description: "The created angle." --- diff --git a/docs/libraries/_G/CreateEntityByName.md b/docs/libraries/_G/CreateEntityByName.md index 44028292d4..8700e39c5a 100644 --- a/docs/libraries/_G/CreateEntityByName.md +++ b/docs/libraries/_G/CreateEntityByName.md @@ -17,7 +17,7 @@ lua: - name: "className" type: string returns: - - type: entity + - type: Entity description: "The created entity" --- diff --git a/docs/libraries/_G/Entity.md b/docs/libraries/_G/Entity.md index 008fcde51e..de9af2a785 100644 --- a/docs/libraries/_G/Entity.md +++ b/docs/libraries/_G/Entity.md @@ -17,7 +17,7 @@ lua: - name: "entityIndex" type: number returns: - - type: entity + - type: Entity description: "The found entity or NULL entity" --- diff --git a/game/experiment/addons/gmod_compatibility/scripts/lua/includes/modules/gmod_compatibility/sh_init.lua b/game/experiment/addons/gmod_compatibility/scripts/lua/includes/modules/gmod_compatibility/sh_init.lua index da502eb7a9..4ded3f9a83 100644 --- a/game/experiment/addons/gmod_compatibility/scripts/lua/includes/modules/gmod_compatibility/sh_init.lua +++ b/game/experiment/addons/gmod_compatibility/scripts/lua/includes/modules/gmod_compatibility/sh_init.lua @@ -365,6 +365,7 @@ ANGLE_META.Div = ANGLE_META.Divide ANGLE_META.Mul = ANGLE_META.Scale local ENTITY_META = FindMetaTable("Entity") +ENTITY_META.Health = ENTITY_META.GetHealth ENTITY_META.GetPos = ENTITY_META.GetPosition ENTITY_META.SetPos = ENTITY_META.SetPosition ENTITY_META.EyePos = ENTITY_META.GetEyePosition diff --git a/src/game/shared/lsrcinit.cpp b/src/game/shared/lsrcinit.cpp index afbadb5858..e0ac118a0d 100644 --- a/src/game/shared/lsrcinit.cpp +++ b/src/game/shared/lsrcinit.cpp @@ -35,7 +35,7 @@ static const luaL_RegForState luasrclibs[] = { { LUA_BASEPLAYERMETANAME, luaopen_CBasePlayer, REALM_SHARED }, // n/a empty ✔ { LUA_PLAYERSLIBNAME, luaopen_Players, REALM_SHARED }, // ✔ n/a n/a { LUA_CBASEFLEXLIBNAME, luaopen_CBaseFlex_shared, REALM_SHARED }, // ✔ n/a n/a - { LUA_COLORLIBNAME, luaopen_Color, REALM_SHARED | REALM_GAMEUI }, // ✔ n/a n/a + { LUA_COLORMETANAME, luaopen_Color, REALM_SHARED | REALM_GAMEUI }, // ✔ n/a n/a { LUA_CONCOMMANDLIBNAME, luaopen_ConsoleCommandMeta, REALM_SHARED | REALM_GAMEUI }, // ✔ n/a n/a { LUA_CONTENTSLIBNAME, luaopen_CONTENTS, REALM_SHARED | REALM_GAMEUI }, { LUA_CONVARLIBNAME, luaopen_ConsoleVariableMeta, REALM_SHARED | REALM_GAMEUI }, // ✔ n/a n/a diff --git a/src/game/shared/luasrclib.h b/src/game/shared/luasrclib.h index 39376ff8b3..294055f74d 100644 --- a/src/game/shared/luasrclib.h +++ b/src/game/shared/luasrclib.h @@ -41,7 +41,7 @@ LUALIB_API int( luaopen_CGameTrace )( lua_State *L ); #define LUA_EXPERIMENTPLAYERLIBNAME "CExperimentPlayer" LUALIB_API int( luaopen_CExperiment_Player_shared )( lua_State *L ); -#define LUA_COLORLIBNAME "Color" +#define LUA_COLORMETANAME "Color" LUALIB_API int( luaopen_Color )( lua_State *L ); #define LUA_CONCOMMANDLIBNAME "ConsoleCommands" diff --git a/src/lib/public/vgui_controls.lib b/src/lib/public/vgui_controls.lib index 6825a5dc4a..f18e69b0ac 100644 --- a/src/lib/public/vgui_controls.lib +++ b/src/lib/public/vgui_controls.lib @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6af2b23cfd1ed42ba1698f5bf52f5a4de29b8c8fdf0a49397b99972530a4eb39 +oid sha256:d3065f7456d5c27096b287c0115e4d54a0f9151585b5e2346754202cbe89823a size 19481326 diff --git a/src/public/lColor.cpp b/src/public/lColor.cpp index e745f0c535..e644c6c2bc 100644 --- a/src/public/lColor.cpp +++ b/src/public/lColor.cpp @@ -14,7 +14,7 @@ LUA_API lua_Color &lua_tocolor( lua_State *L, int idx ) { - lua_Color *clr = ( lua_Color * )luaL_checkudata( L, idx, "Color" ); + lua_Color *clr = ( lua_Color * )luaL_checkudata( L, idx, LUA_COLORMETANAME ); return *clr; } @@ -26,21 +26,21 @@ LUA_API void lua_pushcolor( lua_State *L, lua_Color &clr ) { lua_Color *pColor = ( lua_Color * )lua_newuserdata( L, sizeof( lua_Color ) ); *pColor = clr; - LUA_SAFE_SET_METATABLE( L, "Color" ); + LUA_SAFE_SET_METATABLE( L, LUA_COLORMETANAME ); } LUA_API void lua_pushcolor( lua_State *L, Color &clr ) { lua_Color *pColor = ( lua_Color * )lua_newuserdata( L, sizeof( lua_Color ) ); *pColor = lua_Color( clr.r(), clr.g(), clr.b(), clr.a() ); - LUA_SAFE_SET_METATABLE( L, "Color" ); + LUA_SAFE_SET_METATABLE( L, LUA_COLORMETANAME ); } LUALIB_API lua_Color &luaL_checkcolor( lua_State *L, int narg ) { if ( lua_isuserdata(L, narg) ) { - lua_Color *d = ( lua_Color * )luaL_checkudata( L, narg, "Color" ); + lua_Color *d = ( lua_Color * )luaL_checkudata( L, narg, LUA_COLORMETANAME ); return *d; } @@ -52,7 +52,7 @@ LUALIB_API lua_Color &luaL_checkcolor( lua_State *L, int narg ) lua_getmetatable( L, narg ); lua_getfield( L, -1, "__type" ); - if ( lua_isstring( L, -1 ) && !strcmp( lua_tostring( L, -1 ), "Color" ) ) + if ( lua_isstring( L, -1 ) && !strcmp( lua_tostring( L, -1 ), LUA_COLORMETANAME ) ) { lua_pop( L, 2 ); lua_pushcolor( L, lua_Color( lua_tonumber( L, narg ), lua_tonumber( L, narg + 1 ), lua_tonumber( L, narg + 2 ), lua_tonumber( L, narg + 3 ) ) ); @@ -61,7 +61,7 @@ LUALIB_API lua_Color &luaL_checkcolor( lua_State *L, int narg ) lua_pop( L, 2 ); } - luaL_typerror( L, narg, "Color" ); + luaL_typerror( L, narg, LUA_COLORMETANAME ); return *static_cast< lua_Color * >( 0 ); } @@ -158,7 +158,7 @@ LUA_BINDING_END( "boolean", "Whether the colors are equal." ) LUA_BINDING_BEGIN( Color, __index, "class", "Metamethod for when the index field doesn't exist. Returns values when indexing r, g, b, a or 1, 2, 3, 4." ) { - lua_Color *color = &LUA_BINDING_ARGUMENT( lua_tocolor, 1, "color" ); + lua_Color *color = &LUA_BINDING_ARGUMENT( luaL_checkcolor, 1, "color" ); LUA_METATABLE_INDEX_CHECK( L, color ); const char *field = LUA_BINDING_ARGUMENT( luaL_checkstring, 2, "field" ); @@ -173,9 +173,6 @@ LUA_BINDING_BEGIN( Color, __index, "class", "Metamethod for when the index field lua_pushinteger( L, color->a() ); else { - LUA_GET_REF_TABLE( L, color ); - LUA_METATABLE_INDEX_CHECK_REF_TABLE( L, color ); - if ( lua_getmetatable( L, 1 ) ) { LUA_METATABLE_INDEX_CHECK_TABLE( L ); @@ -190,7 +187,7 @@ LUA_BINDING_END( "any", "The value of the field." ) LUA_BINDING_BEGIN( Color, __newindex, "class", "Metamethod for when the newindex field doesn't exist. Sets values when indexing r, g, b, a or 1, 2, 3, 4." ) { - lua_Color *color = &LUA_BINDING_ARGUMENT( lua_tocolor, 1, "color" ); + lua_Color *color = &LUA_BINDING_ARGUMENT( luaL_checkcolor, 1, "color" ); LUA_METATABLE_INDEX_CHECK( L, color ); const char *field = LUA_BINDING_ARGUMENT( luaL_checkstring, 2, "field" ); @@ -205,10 +202,7 @@ LUA_BINDING_BEGIN( Color, __newindex, "class", "Metamethod for when the newindex color->SetColor( color->r(), color->g(), color->b(), LUA_BINDING_ARGUMENT( luaL_checknumber, 3, "alpha" ) ); else { - LUA_GET_REF_TABLE( L, color ); - lua_pushvalue( L, 3 ); - lua_setfield( L, -2, field ); - lua_pop( L, 1 ); + luaL_error( L, "attempt to set a field in a read-only table" ); } return 0; @@ -373,11 +367,11 @@ LUA_BINDING_END( "color", "The converted color." ) */ LUALIB_API int luaopen_Color( lua_State *L ) { - LUA_PUSH_NEW_METATABLE( L, LUA_COLORLIBNAME ); + LUA_PUSH_NEW_METATABLE( L, LUA_COLORMETANAME ); LUA_REGISTRATION_COMMIT( Color ); - lua_pushstring( L, "Color" ); + lua_pushstring( L, LUA_COLORMETANAME ); lua_setfield( L, -2, "__type" ); /* metatable.__type = "Color" */ LUA_REGISTRATION_COMMIT_LIBRARY( _G ); diff --git a/src/public/lgametrace.cpp b/src/public/lgametrace.cpp index f78af76f01..5c68eaa66f 100644 --- a/src/public/lgametrace.cpp +++ b/src/public/lgametrace.cpp @@ -451,7 +451,7 @@ LUA_API void lua_checktracestruct( lua_State *L, int narg ) luaL_checktype( L, 1, LUA_TTABLE ); } -LUA_API void lua_checktracestruct( lua_State *L, int narg, Vector &start, Vector &end, int &mask, int &collisionGroup, bool &bIgnoreWorld, bool &bFilterTableInverted, bool &bOutput, CTraceLuaFilter *filter ) +LUA_API void lua_checktracestruct( lua_State *L, int narg, Vector &start, Vector &end, int &mask, int &collisionGroup, bool &bIgnoreWorld, bool &bFilterTableInverted, bool &bOutput, CTraceLuaFilter **filter ) { lua_checktracestruct( L, narg ); @@ -487,7 +487,7 @@ LUA_API void lua_checktracestruct( lua_State *L, int narg, Vector &start, Vector lua_pop( L, 1 ); lua_getfield( L, narg, "filter" ); - filter = new CTraceLuaFilter( L, -1, collisionGroup, bIgnoreWorld, bFilterTableInverted ); + *filter = new CTraceLuaFilter( L, -1, collisionGroup, bIgnoreWorld, bFilterTableInverted ); // lua_pop( L, 1 ); // Don't pop the filter. CTraceLuaFilter will handle it, leaving the filter on the stack if it's a function } @@ -499,7 +499,7 @@ LUA_BINDING_BEGIN( Traces, TraceLine, "library", "Trace a line." ) CTraceLuaFilter *filter = nullptr; LUA_BINDING_ARGUMENT( lua_checktracestruct, 1, "trace" ); - lua_checktracestruct( L, 1, vecStart, vecEnd, mask, collisionGroup, bIgnoreWorld, bFilterTableInverted, bOutput, filter ); + lua_checktracestruct( L, 1, vecStart, vecEnd, mask, collisionGroup, bIgnoreWorld, bFilterTableInverted, bOutput, &filter ); trace_t gameTrace; Ray_t ray; @@ -531,7 +531,7 @@ LUA_BINDING_BEGIN( Traces, TraceHull, "library", "Trace a hull." ) CTraceLuaFilter *filter = nullptr; LUA_BINDING_ARGUMENT( lua_checktracestruct, 1, "trace" ); - lua_checktracestruct( L, 1, vecStart, vecEnd, mask, collisionGroup, bIgnoreWorld, bFilterTableInverted, bOutput, filter ); + lua_checktracestruct( L, 1, vecStart, vecEnd, mask, collisionGroup, bIgnoreWorld, bFilterTableInverted, bOutput, &filter ); trace_t gameTrace; Ray_t ray; @@ -562,7 +562,7 @@ LUA_BINDING_BEGIN( Traces, TraceEntity, "library", "Runs a trace using the entit CTraceLuaFilter *filter = nullptr; LUA_BINDING_ARGUMENT( lua_checktracestruct, 1, "trace" ); - lua_checktracestruct( L, 1, vecStart, vecEnd, mask, collisionGroup, bIgnoreWorld, bFilterTableInverted, bOutput, filter ); + lua_checktracestruct( L, 1, vecStart, vecEnd, mask, collisionGroup, bIgnoreWorld, bFilterTableInverted, bOutput, &filter ); trace_t gameTrace; UTIL_TraceEntity( entity, vecStart, vecEnd, mask, filter, &gameTrace ); @@ -589,11 +589,6 @@ LUA_BINDING_BEGIN( Traces, PointContents, "library", "Returns the contents mask } LUA_BINDING_END( "number", "The contents of the point." ) -// static int luasrc_Util_TraceModel( lua_State *L ) -//{ -// UTIL_TraceModel( luaL_checkvector( L, 1 ), luaL_checkvector( L, 2 ), luaL_checkvector( L, 3 ), luaL_checkvector( L, 4 ), luaL_checkentity( L, 5 ), luaL_checknumber( L, 6 ), &luaL_checktrace( L, 7 ) ); -// return 0; -// } LUA_BINDING_BEGIN( Traces, TraceModel, "library", "Sweeps against a particular model, using collision rules." ) { Vector vecStart, vecEnd, vecMins, vecMaxs; diff --git a/src/public/lgametrace.h b/src/public/lgametrace.h index 76b1cdcf73..f61c3ea6cc 100644 --- a/src/public/lgametrace.h +++ b/src/public/lgametrace.h @@ -43,6 +43,6 @@ class CTraceLuaFilter : public CTraceFilterSimple }; LUA_API void lua_checktracestruct( lua_State *L, int narg ); -LUA_API void lua_checktracestruct( lua_State *L, int narg, Vector &start, Vector &end, int &mask, int &collisionGroup, bool &bIgnoreWorld, bool &bFilterTableInverted, bool &bOutput, CTraceLuaFilter *filter ); +LUA_API void lua_checktracestruct( lua_State *L, int narg, Vector &start, Vector &end, int &mask, int &collisionGroup, bool &bIgnoreWorld, bool &bFilterTableInverted, bool &bOutput, CTraceLuaFilter **filter ); #endif // LGAMETRACE_H diff --git a/src/public/lnetwork.cpp b/src/public/lnetwork.cpp index 5975034c0a..2f49435b1c 100644 --- a/src/public/lnetwork.cpp +++ b/src/public/lnetwork.cpp @@ -331,7 +331,7 @@ LUALIB_API bf_read *luaL_checkbf_read( lua_State *L, int narg ) return bfRead; } -LUA_BINDING_BEGIN( UserMessageReader, ReadBit, "library", "Reads a bit.", "client" ) +LUA_BINDING_BEGIN( UserMessageReader, ReadBit, "class", "Reads a bit.", "client" ) { bf_read *bf = LUA_BINDING_ARGUMENT( luaL_checkbf_read, 1, "reader" ); lua_pushinteger( L, bf->ReadOneBit() ); @@ -339,7 +339,7 @@ LUA_BINDING_BEGIN( UserMessageReader, ReadBit, "library", "Reads a bit.", "clien } LUA_BINDING_END( "integer", "The bit read." ) -LUA_BINDING_BEGIN( UserMessageReader, ReadByte, "library", "Reads a byte.", "client" ) +LUA_BINDING_BEGIN( UserMessageReader, ReadByte, "class", "Reads a byte.", "client" ) { bf_read *bf = LUA_BINDING_ARGUMENT( luaL_checkbf_read, 1, "reader" ); lua_pushinteger( L, bf->ReadByte() ); @@ -347,7 +347,7 @@ LUA_BINDING_BEGIN( UserMessageReader, ReadByte, "library", "Reads a byte.", "cli } LUA_BINDING_END( "integer", "The byte read." ) -LUA_BINDING_BEGIN( UserMessageReader, ReadChar, "library", "Reads a char.", "client" ) +LUA_BINDING_BEGIN( UserMessageReader, ReadChar, "class", "Reads a char.", "client" ) { bf_read *bf = LUA_BINDING_ARGUMENT( luaL_checkbf_read, 1, "reader" ); lua_pushinteger( L, bf->ReadChar() ); @@ -355,7 +355,7 @@ LUA_BINDING_BEGIN( UserMessageReader, ReadChar, "library", "Reads a char.", "cli } LUA_BINDING_END( "integer", "The char read." ) -LUA_BINDING_BEGIN( UserMessageReader, ReadShort, "library", "Reads a short integer.", "client" ) +LUA_BINDING_BEGIN( UserMessageReader, ReadShort, "class", "Reads a short integer.", "client" ) { bf_read *bf = LUA_BINDING_ARGUMENT( luaL_checkbf_read, 1, "reader" ); lua_pushinteger( L, bf->ReadShort() ); @@ -363,7 +363,7 @@ LUA_BINDING_BEGIN( UserMessageReader, ReadShort, "library", "Reads a short integ } LUA_BINDING_END( "integer", "The short read." ) -LUA_BINDING_BEGIN( UserMessageReader, ReadWord, "library", "Reads a word.", "client" ) +LUA_BINDING_BEGIN( UserMessageReader, ReadWord, "class", "Reads a word.", "client" ) { bf_read *bf = LUA_BINDING_ARGUMENT( luaL_checkbf_read, 1, "reader" ); lua_pushinteger( L, bf->ReadWord() ); @@ -371,7 +371,7 @@ LUA_BINDING_BEGIN( UserMessageReader, ReadWord, "library", "Reads a word.", "cli } LUA_BINDING_END( "integer", "The word read." ) -LUA_BINDING_BEGIN( UserMessageReader, ReadLong, "library", "Reads a long integer.", "client" ) +LUA_BINDING_BEGIN( UserMessageReader, ReadLong, "class", "Reads a long integer.", "client" ) { bf_read *bf = LUA_BINDING_ARGUMENT( luaL_checkbf_read, 1, "reader" ); lua_pushinteger( L, bf->ReadBitLong( luaL_checknumber( L, 2 ), lua_toboolean( L, 3 ) ) ); @@ -379,7 +379,7 @@ LUA_BINDING_BEGIN( UserMessageReader, ReadLong, "library", "Reads a long integer } LUA_BINDING_END( "integer", "The long read." ) -LUA_BINDING_BEGIN( UserMessageReader, ReadFloat, "library", "Reads a float.", "client" ) +LUA_BINDING_BEGIN( UserMessageReader, ReadFloat, "class", "Reads a float.", "client" ) { bf_read *bf = LUA_BINDING_ARGUMENT( luaL_checkbf_read, 1, "reader" ); lua_pushnumber( L, bf->ReadBitFloat() ); @@ -387,7 +387,7 @@ LUA_BINDING_BEGIN( UserMessageReader, ReadFloat, "library", "Reads a float.", "c } LUA_BINDING_END( "number", "The float read." ) -LUA_BINDING_BEGIN( UserMessageReader, ReadVector, "library", "Reads a vector.", "client" ) +LUA_BINDING_BEGIN( UserMessageReader, ReadVector, "class", "Reads a vector.", "client" ) { bf_read *bf = LUA_BINDING_ARGUMENT( luaL_checkbf_read, 1, "reader" ); Vector vec; @@ -397,7 +397,7 @@ LUA_BINDING_BEGIN( UserMessageReader, ReadVector, "library", "Reads a vector.", } LUA_BINDING_END( "Vector", "The vector read." ) -LUA_BINDING_BEGIN( UserMessageReader, ReadVectorNormal, "library", "Reads a normal vector.", "client" ) +LUA_BINDING_BEGIN( UserMessageReader, ReadVectorNormal, "class", "Reads a normal vector.", "client" ) { bf_read *bf = LUA_BINDING_ARGUMENT( luaL_checkbf_read, 1, "reader" ); Vector vec; @@ -407,7 +407,7 @@ LUA_BINDING_BEGIN( UserMessageReader, ReadVectorNormal, "library", "Reads a norm } LUA_BINDING_END( "Vector", "The normal vector read." ) -LUA_BINDING_BEGIN( UserMessageReader, ReadAngle, "library", "Reads an angle.", "client" ) +LUA_BINDING_BEGIN( UserMessageReader, ReadAngle, "class", "Reads an angle.", "client" ) { bf_read *bf = LUA_BINDING_ARGUMENT( luaL_checkbf_read, 1, "reader" ); QAngle ang; @@ -417,7 +417,7 @@ LUA_BINDING_BEGIN( UserMessageReader, ReadAngle, "library", "Reads an angle.", " } LUA_BINDING_END( "Angle", "The angle read." ) -LUA_BINDING_BEGIN( UserMessageReader, ReadString, "library", "Reads a string.", "client" ) +LUA_BINDING_BEGIN( UserMessageReader, ReadString, "class", "Reads a string.", "client" ) { bf_read *bf = LUA_BINDING_ARGUMENT( luaL_checkbf_read, 1, "reader" ); char str[2048]; @@ -427,7 +427,7 @@ LUA_BINDING_BEGIN( UserMessageReader, ReadString, "library", "Reads a string.", } LUA_BINDING_END( "string", "The string read." ) -LUA_BINDING_BEGIN( UserMessageReader, ReadBytes, "library", "Reads a number of bytes.", "client" ) +LUA_BINDING_BEGIN( UserMessageReader, ReadBytes, "class", "Reads a number of bytes.", "client" ) { bf_read *bf = LUA_BINDING_ARGUMENT( luaL_checkbf_read, 1, "reader" ); int len = luaL_checknumber( L, 2 ); @@ -439,7 +439,7 @@ LUA_BINDING_BEGIN( UserMessageReader, ReadBytes, "library", "Reads a number of b } LUA_BINDING_END( "string", "The bytes read." ) -LUA_BINDING_BEGIN( UserMessageReader, ReadEntity, "library", "Reads an entity.", "client" ) +LUA_BINDING_BEGIN( UserMessageReader, ReadEntity, "class", "Reads an entity.", "client" ) { bf_read *bf = LUA_BINDING_ARGUMENT( luaL_checkbf_read, 1, "reader" ); unsigned int iEncodedEHandle = bf->ReadLong(); diff --git a/src/public/lnetworkstringtabledefs.cpp b/src/public/lnetworkstringtabledefs.cpp index bb7ca243bd..de75022b4d 100644 --- a/src/public/lnetworkstringtabledefs.cpp +++ b/src/public/lnetworkstringtabledefs.cpp @@ -262,7 +262,7 @@ extern INetworkStringTableContainer *networkstringtable; LUA_REGISTRATION_INIT( NetworkStringTables ) -LUA_BINDING_BEGIN( NetworkStringTables, CreateStringTable, "library", "Create a new string table." ) +LUA_BINDING_BEGIN( NetworkStringTables, Create, "library", "Create a new string table." ) { const char *name = LUA_BINDING_ARGUMENT( luaL_checkstring, 1, "name" ); int maxEntries = LUA_BINDING_ARGUMENT( luaL_checknumber, 2, "maxEntries" ); @@ -275,7 +275,7 @@ LUA_BINDING_BEGIN( NetworkStringTables, CreateStringTable, "library", "Create a } LUA_BINDING_END( "NetworkStringTable", "The created string table." ) -LUA_BINDING_BEGIN( NetworkStringTables, CreateStringTableEx, "library", "Create a new string table." ) +LUA_BINDING_BEGIN( NetworkStringTables, CreateExtended, "library", "Create a new string table." ) { const char *name = LUA_BINDING_ARGUMENT( luaL_checkstring, 1, "name" ); int maxEntries = LUA_BINDING_ARGUMENT( luaL_checknumber, 2, "maxEntries" ); diff --git a/tools/docs-build-functions.js b/tools/docs-build-functions.js index ee9fb1f17a..a3c7e1e12b 100644 --- a/tools/docs-build-functions.js +++ b/tools/docs-build-functions.js @@ -81,7 +81,8 @@ function writeFunctionToFile(func) { if (functionsThisRun.has(filePath)) { const existingFunc = functionsThisRun.get(filePath); - if (existingFunc.realm !== func.realm) { + if (existingFunc.realm !== func.realm + && existingFunc.concept === func.concept ) { const newFileName = `${existingFunc.function}.${existingFunc.realm}.md`; const newFilePath = path.join(outputDir, directory, getLibrary(func), newFileName); @@ -296,6 +297,12 @@ function fromTypeChecker(typeChecker) { case 'luaL_optbf_read': case 'lua_tobf_read': return 'UserMessageReader'; + case 'lua_checktracestruct': + return 'Trace'; + case 'luaL_checkfont': + case 'luaL_optfont': + case 'lua_tofont': + return 'FontHandle'; default: return 'unknown'; }