@tlua/gmod 1.0.1

package/vehicle.d.tlua

@@ -0,0 +1,472 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * This is a list of all methods only available for vehicles. It is also possible to call [Entity](https://wiki.facepunch.com/gmod/Entity) functions on vehicles.
+ * @source https://wiki.facepunch.com/gmod/Vehicle
+ */
+interface Vehicle extends Entity {}
+interface VEHICLE extends Vehicle {}
+
+interface Vehicle {
+    /**
+     * Returns the remaining boosting time left.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:BoostTimeLeft
+     */
+    BoostTimeLeft(self: Vehicle): number;
+}
+
+interface Vehicle {
+    /**
+     * Tries to find an Exit Point for leaving vehicle, if one is unobstructed in the direction given.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:CheckExitPoint
+     */
+    CheckExitPoint(self: Vehicle, yaw: number, distance: number): Vector;
+}
+
+interface Vehicle {
+    /**
+     * Sets whether the engine is enabled or disabled, i.e. can be started or not.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:EnableEngine
+     */
+    EnableEngine(self: Vehicle, enable: boolean): void;
+}
+
+interface Vehicle {
+    /**
+     * Returns information about the ammo of the vehicle
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetAmmo
+     */
+    GetAmmo(self: Vehicle): (number, number, number);
+}
+
+interface Vehicle {
+    /**
+     * Returns third person camera distance.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetCameraDistance
+     */
+    GetCameraDistance(self: Vehicle): number;
+}
+
+interface Vehicle {
+    /**
+     * Gets the driver of the vehicle, returns NULL Entity if no driver is present.
+     * In Garry's Mod, only Players can drive vehicles.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetDriver
+     */
+    GetDriver(self: Vehicle): Player | NULL;
+}
+
+
+interface Vehicle {
+    /**
+     * Returns the current speed of the vehicle in Half-Life Hammer Units (in/s). Same as [Entity:GetVelocity](https://wiki.facepunch.com/gmod/Entity:GetVelocity) + [Vector:Length](https://wiki.facepunch.com/gmod/Vector:Length).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetHLSpeed
+     */
+    GetHLSpeed(self: Vehicle): number;
+}
+
+interface Vehicle {
+    /**
+     * Returns the max speed of the vehicle in MPH.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetMaxSpeed
+     */
+    GetMaxSpeed(self: Vehicle): number;
+}
+
+interface Vehicle {
+    /**
+     * Returns some info about the vehicle.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetOperatingParams
+     */
+    GetOperatingParams(self: Vehicle): OperatingParams;
+}
+
+interface Vehicle {
+    /**
+     * Gets the passenger of the vehicle, returns [NULL](https://wiki.facepunch.com/gmod/NULL) if no drivers is present.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetPassenger
+     */
+    GetPassenger(self: Vehicle, passenger: number): Entity;
+}
+
+interface Vehicle {
+    /**
+     * Returns the seat position and angle of a given passenger seat.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetPassengerSeatPoint
+     */
+    GetPassengerSeatPoint(self: Vehicle, role: number): (Vector, Angle);
+}
+
+interface Vehicle {
+    /**
+     * Returns the current RPM of the vehicle. This value is fake and doesn't actually affect the vehicle movement.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetRPM
+     */
+    GetRPM(self: Vehicle): number;
+}
+
+interface Vehicle {
+    /**
+     * Returns the current speed of the vehicle in MPH.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetSpeed
+     */
+    GetSpeed(self: Vehicle): number;
+}
+
+interface Vehicle {
+    /**
+     * Returns the current steering of the vehicle.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetSteering
+     */
+    GetSteering(self: Vehicle): number;
+}
+
+interface Vehicle {
+    /**
+     * Returns the maximum steering degree of the vehicle
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetSteeringDegrees
+     */
+    GetSteeringDegrees(self: Vehicle): number;
+}
+
+interface Vehicle {
+    /**
+     * Returns if vehicle has thirdperson mode enabled or not.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetThirdPersonMode
+     */
+    GetThirdPersonMode(self: Vehicle): boolean;
+}
+
+interface Vehicle {
+    /**
+     * Returns the current throttle of the vehicle.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetThrottle
+     */
+    GetThrottle(self: Vehicle): number;
+}
+
+interface Vehicle {
+    /**
+     * Returns the vehicle class name. This is only useful for Sandbox spawned vehicles or any vehicle that properly sets the vehicle class with [Vehicle:SetVehicleClass](https://wiki.facepunch.com/gmod/Vehicle:SetVehicleClass).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetVehicleClass
+     */
+    GetVehicleClass(self: Vehicle): string;
+}
+
+interface Vehicle {
+    /**
+     * Returns the vehicle parameters of given vehicle.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetVehicleParams
+     */
+    GetVehicleParams(self: Vehicle): VehicleParams;
+}
+
+interface Vehicle {
+    /**
+     * Returns the view position and forward angle of a given passenger seat.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetVehicleViewPosition
+     */
+    GetVehicleViewPosition(self: Vehicle, role?: number): (Vector, Angle, number);
+}
+
+interface Vehicle {
+    /**
+     * Returns the [PhysObj](https://wiki.facepunch.com/gmod/PhysObj) of given wheel.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetWheel
+     */
+    GetWheel(self: Vehicle, wheel: number): PhysObj;
+}
+
+interface Vehicle {
+    /**
+     * Returns the base wheel height.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetWheelBaseHeight
+     */
+    GetWheelBaseHeight(self: Vehicle, wheel: number): number;
+}
+
+interface Vehicle {
+    /**
+     * Returns the wheel contact point.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetWheelContactPoint
+     */
+    GetWheelContactPoint(self: Vehicle, wheel: number): (Vector, number, boolean);
+}
+
+interface Vehicle {
+    /**
+     * Returns the wheel count of the vehicle
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetWheelCount
+     */
+    GetWheelCount(self: Vehicle): number;
+}
+
+interface Vehicle {
+    /**
+     * Returns the total wheel height.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:GetWheelTotalHeight
+     */
+    GetWheelTotalHeight(self: Vehicle, wheel: number): number;
+}
+
+interface Vehicle {
+    /**
+     * Returns whether this vehicle has boost at all.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:HasBoost
+     */
+    HasBoost(self: Vehicle): boolean;
+}
+
+interface Vehicle {
+    /**
+     * Returns whether this vehicle has a brake pedal. See [Vehicle:SetHasBrakePedal](https://wiki.facepunch.com/gmod/Vehicle:SetHasBrakePedal).
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:HasBrakePedal
+     */
+    HasBrakePedal(self: Vehicle): boolean;
+}
+
+interface Vehicle {
+    /**
+     * Returns whether this vehicle is currently boosting or not.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:IsBoosting
+     */
+    IsBoosting(self: Vehicle): boolean;
+}
+
+interface Vehicle {
+    /**
+     * Returns whether the engine is enabled or not, i.e. whether it can be started.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:IsEngineEnabled
+     */
+    IsEngineEnabled(self: Vehicle): boolean;
+}
+
+interface Vehicle {
+    /**
+     * Returns whether the engine is started or not.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:IsEngineStarted
+     */
+    IsEngineStarted(self: Vehicle): boolean;
+}
+
+interface Vehicle {
+    /**
+     * Determines whether a given [Vehicle](https://wiki.facepunch.com/gmod/Vehicle) is fully initialized.
+     *
+     * It is possible, in uncommon circumstances, for a [valid](https://wiki.facepunch.com/gmod/Global.IsValid) [vehicle](https://wiki.facepunch.com/gmod/Entity:IsVehicle) entity to be in an invalid state, such as before [Entity:Spawn](https://wiki.facepunch.com/gmod/Entity:Spawn) is called on the vehicle after creation.
+     *
+     * If this function returns `false`, then the [Vehicle](https://wiki.facepunch.com/gmod/Vehicle) functions are not usable on this vehicle, while [Entity](https://wiki.facepunch.com/gmod/Entity) functions are.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Vehicle:IsValidVehicle
+     */
+    IsValidVehicle(self: Vehicle): boolean;
+}
+
+interface Vehicle {
+    /**
+     * Returns whether this vehicle's engine is underwater or not. ( Internally the attachment point "engine" or "vehicle_engine" is checked )
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:IsVehicleBodyInWater
+     */
+    IsVehicleBodyInWater(self: Vehicle): boolean;
+}
+
+interface Vehicle {
+    /**
+     * Releases the vehicle's handbrake (Jeep) so it can roll without any passengers.
+     *
+     * This will be overwritten if the vehicle has a driver. Same as [Vehicle:SetHandbrake](https://wiki.facepunch.com/gmod/Vehicle:SetHandbrake)( false )
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:ReleaseHandbrake
+     */
+    ReleaseHandbrake(self: Vehicle): void;
+}
+
+interface Vehicle {
+    /**
+     * Sets the boost. It is possible that this function does not work while the vehicle has a valid driver in it.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:SetBoost
+     */
+    SetBoost(self: Vehicle, boost: number): void;
+}
+
+interface Vehicle {
+    /**
+     * Sets the third person camera distance of the vehicle.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Vehicle:SetCameraDistance
+     */
+    SetCameraDistance(self: Vehicle, distance: number): void;
+}
+
+interface Vehicle {
+    /**
+     * Turns on or off the Jeep handbrake so it can roll without a driver inside.
+     *
+     * Does nothing while the vehicle has a driver in it.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:SetHandbrake
+     */
+    SetHandbrake(self: Vehicle, handbrake: boolean): void;
+}
+
+interface Vehicle {
+    /**
+     * Sets whether this vehicle has a brake pedal.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:SetHasBrakePedal
+     */
+    SetHasBrakePedal(self: Vehicle, brakePedal: boolean): void;
+}
+
+interface Vehicle {
+    /**
+     * Sets maximum reverse throttle
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:SetMaxReverseThrottle
+     */
+    SetMaxReverseThrottle(self: Vehicle, maxRevThrottle: number): void;
+}
+
+interface Vehicle {
+    /**
+     * Sets maximum forward throttle
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:SetMaxThrottle
+     */
+    SetMaxThrottle(self: Vehicle, maxThrottle: number): void;
+}
+
+interface Vehicle {
+    /**
+     * Sets spring length of given wheel
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:SetSpringLength
+     */
+    SetSpringLength(self: Vehicle, wheel: number, length: number): void;
+}
+
+interface Vehicle {
+    /**
+     * Sets the steering of the vehicle.
+     * The correct range, 0 to 1 or -1 to 1
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:SetSteering
+     */
+    SetSteering(self: Vehicle, front: number, rear: number): void;
+}
+
+interface Vehicle {
+    /**
+     * Sets the maximum steering degrees of the vehicle
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:SetSteeringDegrees
+     */
+    SetSteeringDegrees(self: Vehicle, steeringDegrees: number): void;
+}
+
+interface Vehicle {
+    /**
+     * Sets the third person mode state.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Vehicle:SetThirdPersonMode
+     */
+    SetThirdPersonMode(self: Vehicle, enable: boolean): void;
+}
+
+interface Vehicle {
+    /**
+     * Sets the throttle of the vehicle. It is possible that this function does not work with a valid driver in it.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:SetThrottle
+     */
+    SetThrottle(self: Vehicle, throttle: number): void;
+}
+
+interface Vehicle {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Sets the vehicle class name.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Vehicle:SetVehicleClass
+     */
+    SetVehicleClass(self: Vehicle, _class: string): void;
+}
+
+interface Vehicle {
+    /**
+     * Sets whether the entry or exit camera animation should be played or not.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:SetVehicleEntryAnim
+     */
+    SetVehicleEntryAnim(self: Vehicle, bOn: boolean): void;
+}
+
+interface Vehicle {
+    /**
+     * Sets the vehicle parameters for given vehicle.
+     *
+     * **NOTE**: Not all variables from the [Structures/VehicleParams](https://wiki.facepunch.com/gmod/Structures/VehicleParams) can be set.
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:SetVehicleParams
+     */
+    SetVehicleParams(self: Vehicle, params: VehicleParams): void;
+}
+
+interface Vehicle {
+    /**
+     * Sets friction of given wheel.  This function may be broken.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:SetWheelFriction
+     */
+    SetWheelFriction(self: Vehicle, wheel: number, friction: number): void;
+}
+
+interface Vehicle {
+    /**
+     * Starts or stops the engine.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/Vehicle:StartEngine
+     */
+    StartEngine(self: Vehicle, start: boolean): void;
+}
+

package/vgui.d.tlua

@@ -0,0 +1,201 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The **vgui** library allows you to script and create your own panels using **V**alve's **G**raphical **U**ser **I**nterface (VGUI) system.
+ *
+ * For an alphabetically ordered list of VGUI panels, see [VGUI Element List](https://wiki.facepunch.com/gmod/VGUI_Element_List).
+ * @source https://wiki.facepunch.com/gmod/vgui
+ */
+declare vgui: VguiLib;
+
+interface VguiLib {
+    /**
+     * Creates a panel by the specified classname. Custom VGUI elements are not
+     * loaded instantly; use GM:OnGamemodeLoaded to create them on startup.
+     *
+     * NOTE: the wiki maps the classname string to a concrete Panel subtype via a
+     * class-string generic; tlua cannot map a string literal to a nominal type, so
+     * this returns the base Panel.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/vgui.Create
+     */
+    Create(classname: string, parent?: Panel, name?: string): Panel;
+}
+
+
+interface VguiLib {
+    /**
+     * Creates a panel from a table, used alongside vgui.RegisterFile and
+     * vgui.RegisterTable to define, register, and instantiate custom panels.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/vgui.CreateFromTable
+     */
+    CreateFromTable(metatable: table, parent?: Panel, name?: string): Panel;
+}
+
+
+interface VguiLib {
+    /**
+     * Creates an engine panel.
+     *
+     * INTERNAL: used internally; although you're able to use it you probably shouldn't.
+     *
+     * NOTE: the wiki maps the class string to a concrete Panel subtype via a
+     * class-string generic; tlua cannot map a string literal to a nominal type, so
+     * this returns the base Panel.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/vgui.CreateX
+     */
+    CreateX(class: string, parent?: Panel, name?: string): Panel;
+}
+
+
+interface VguiLib {
+    /**
+     * Returns whenever the cursor is currently active and visible.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/vgui.CursorVisible
+     */
+    CursorVisible(): boolean;
+}
+
+interface VguiLib {
+    /**
+     * Returns true if Lua-defined panel exists by name. Uses [vgui.GetControlTable](https://wiki.facepunch.com/gmod/vgui.GetControlTable) internally.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/vgui.Exists
+     */
+    Exists(Panelname: string): boolean;
+}
+
+interface VguiLib {
+    /**
+     * Returns whether the currently focused panel is a child of the given one.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/vgui.FocusedHasParent
+     */
+    FocusedHasParent(parent: Panel): boolean;
+}
+
+interface VguiLib {
+    /**
+     * Returns all Lua-created panels.
+     *
+     * Used internally for [PANEL:PreAutoRefresh](https://wiki.facepunch.com/gmod/PANEL:PreAutoRefresh) and [PANEL:PostAutoRefresh](https://wiki.facepunch.com/gmod/PANEL:PostAutoRefresh).
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/vgui.GetAll
+     */
+    GetAll(): Panel[];
+}
+
+interface VguiLib {
+    /**
+     * Returns the table of a Lua-defined panel by name. Does not return parent
+     * members of the table!
+     *
+     * NOTE: the wiki maps the panel name to the concrete PANEL table type via a
+     * class-string generic; tlua cannot map a string literal to a nominal type, so
+     * this degrades to `table`.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/vgui.GetControlTable
+     */
+    GetControlTable(Panelname: string): table;
+}
+
+
+interface VguiLib {
+    /**
+     * Returns the panel the cursor is hovering above.
+     *
+     * **WARNING**: This returns a cached value that is only updated after rendering and `before` the next VGUI Think/Layout pass.
+     *
+     * ie. it lags one frame behind panel layout and is completely unhelpful for [PANEL:Paint](https://wiki.facepunch.com/gmod/PANEL:Paint) if your panels are moving around under the mouse a lot every frame.
+     *
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/vgui.GetHoveredPanel
+     */
+    GetHoveredPanel(): Panel;
+}
+
+interface VguiLib {
+    /**
+     * Returns the panel which is currently receiving keyboard input.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/vgui.GetKeyboardFocus
+     */
+    GetKeyboardFocus(): Panel;
+}
+
+interface VguiLib {
+    /**
+     * Returns the global world panel which is the parent to all others, except for the HUD panel.
+     *
+     * See also [Global.GetHUDPanel](https://wiki.facepunch.com/gmod/Global.GetHUDPanel).
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/vgui.GetWorldPanel
+     */
+    GetWorldPanel(): Panel;
+}
+
+interface VguiLib {
+    /**
+     * Returns whenever the cursor is hovering the world panel.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/vgui.IsHoveringWorld
+     */
+    IsHoveringWorld(): boolean;
+}
+
+interface VguiLib {
+    /**
+     * Registers a panel for later creation via [vgui.Create](https://wiki.facepunch.com/gmod/vgui.Create).
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/vgui.Register
+     */
+    Register(classname: string, panelTable: table, baseName?: string): table;
+}
+
+interface VguiLib {
+    /**
+     * Registers a new [VGUI](https://wiki.facepunch.com/gmod/VGUI) panel from a file, to be used with [vgui.CreateFromTable](https://wiki.facepunch.com/gmod/vgui.CreateFromTable).
+     *
+     * File file must use the `PANEL` global that is provided just before the file is [Global.include](https://wiki.facepunch.com/gmod/Global.include)d, for example:
+     *
+     *
+     * ```
+     * PANEL.Base = "Panel"
+     *
+     * function PANEL:Init()
+     * 	-- Your code...
+     * end
+     *
+     * function PANEL:Think()
+     * 	-- Your code...
+     * end
+     * ```
+     *
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/vgui.RegisterFile
+     */
+    RegisterFile(file: string): table;
+}
+
+interface VguiLib {
+    /**
+     * Registers a table to use as a panel, to be used with [vgui.CreateFromTable](https://wiki.facepunch.com/gmod/vgui.CreateFromTable).
+     *
+     * All this function does is assigns Base key to your table and returns the table.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/vgui.RegisterTable
+     */
+    RegisterTable(panel: table, base?: string): table;
+}
+

package/video.d.tlua

@@ -0,0 +1,17 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The video library.
+ * @source https://wiki.facepunch.com/gmod/video
+ */
+declare video: VideoLib;
+
+interface VideoLib {
+    /**
+     * Attempts to create an [IVideoWriter](https://wiki.facepunch.com/gmod/IVideoWriter).
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/video.Record
+     */
+    Record(config: VideoData): (IVideoWriter, string);
+}
+