Skip to content

E2Helper Entries [Autogenerated]

Wiki Updater edited this page Jul 17, 2020 · 8 revisions

Supported Panels


Every panel has an internal list of players. This player list keeps track of who can see the panel and are targeted when you call create() or modify(). By default this list only contains the E2 owner.
You can edit this list by using the PNL:addPlayer(E)/PNL:removePlayer(E)/PNL:setPlayers() function.
Alternatively you can use vguiDefaultPlayers(R) to set a default for every panel you create.
You can still edit the list of the panel afterwards without affecting other panel's lists or the set default.

These are the basic steps to create and modify a simple panel:

@persist Dframe:dframe #useful when you want to modify the panel afterwards

#1.To make it easier, set the default players list with vguiDefaultPlayers(R)
vguiDefaultPlayers(players()) #everyone will see the panel

#2. Create a panel element of your choice and give it an index
Dframe = dframe(1)

#3. Edit the attributes
Dframe:setTitle("My Frame")
Dframe:setColor(vec(0,255,255))
Dframe:center()
Dframe:makePopup()

#4. Call create() to create the panel
Dframe:create()

#5. If you want to change attributes you have to call modify() to apply changes
Dframe:setColor(vec(255,120,120))
Dframe:modify()

Invalid Functions (WORK IN PROGRESS)

Function Description

General Functions

Function Description
runOnVgui(n) When activated, the E2 will run when a player interacts with the GUI. For example when a button is pressed.
vguiClk() Returns 1 if the chip is being executed because of an gui event. Returns 0 otherwise. See runOnVgui().
vguiClk(e) Returns 1 if the chip is being executed because of an gui event by the player E. Returns 0 otherwise. See runOnVgui().
vguiClkPanelID() Returns the ID of the gui element that triggered the chip's execution. See runOnVgui().
vguiClkPlayer() Returns the Player that interacted with the gui. See runOnVgui().
vguiClkValues() Returns information about the gui event. For example if a colorpicker changed it's color, this will return the selected color values. See runOnVgui().
vguiClkValuesTable() See vguiClkValues. This returns the same data but formatted as a table for easier reading.
vguiCloseAll() Removes all panels created by this E2 on all players.
vguiCloseOnPlayer(e) Removes all panels created by this E2 for a given player E.
vguiDefaultPlayers(r) Defines the default player list that gets used when creating a panel. See addPlayer() and removePlayer() for more info
vguiCanSend() Returns 1 if the vgui element can be created or modified with create()/modify(). Returns 0 otherwise.
dtextentry(n) Creates a new textentry with the given index.
dtextentry(nn) Creates a new textentry with the given index and parents it to the given panel. Can also be a DFrame or DPanel instance.
dspawnicon(n) Creates a new spawnicon with the given index.
dspawnicon(nn) Creates a new spawnicon with the given index and parents it to the given panel. Can also be a DFrame or DPanel instance.
dslider(n) Creates a new slider with the given index.
dslider(nn) Creates a new slider with the given index and parents it to the given panel. Can also be a DFrame or DPanel instance.
dpropertysheet(n) Creates a new propertysheet with the given index and parents it to the given panel. Can also be a DFrame or DPanel instance.
dpropertysheet(nn) Creates a new propertysheet with the given index and parents it to the given panel. Can also be a DFrame or DPanel instance.
dpanel(n) Creates a new panel with the given index.
dpanel(nn) Creates a new panel with the given index and parents it to the given panel. Can also be a DFrame or DPanel instance.
dmodelpanel(n) Creates a new modelpanel with the given index.
dmodelpanel(nn) Creates a new modelpanel with the given index and parents it to the given panel. Can also be a DFrame or DPanel instance.
dlistview(n) Creates a new listview with the given index.
dlistview(nn) Creates a new listview with the given index and parents it to the given panel. Can also be a DFrame or DPanel instance.
dlabel(n) Creates a new label with the given index.
dlabel(nn) Creates a new label with the given index and parents it to the given panel. Can also be a DFrame or DPanel instance.
dimagebutton(n) Creates a new imagebutton with the given index.
dimagebutton(nn) Creates a new imagebutton with the given index and parents it to the given panel. Can also be a DFrame or DPanel instance.
dframe(n) Creates a new frame with the given index.
dcombobox(n) Creates a new combobox with the given index.
dcombobox(nn) Creates a new combobox with the given index and parents it to the given panel. Can also be a DFrame or DPanel instance.
dcolormixer(n) Creates a new colormixer with the given index.
dcolormixer(nn) Creates a new colormixer with the given index and parents it to the given panel. Can also be a DFrame or DPanel instance.
dcheckboxlabel(n) Creates a new labeled checkbox with the given index.
dcheckboxlabel(nn) Creates a new labeled checkbox with the given index and parents it to the given panel. Can also be a DFrame or DPanel instance.
dcheckbox(n) Creates a new checkbox with the given index.
dcheckbox(nn) Creates a new checkbox with the given index and parents it to the given panel. Can also be a DFrame or DPanel instance.
dbutton(n) Creates a new button with the given index.
dbutton(nn) Creates a new button with the given index and parents it to the given panel. Can also be a DFrame or DPanel instance.

dtextentry(xdt)

Function Description
xdt:setText(s) Sets the text of the textentry.
xdt:getText(e) Returns the text of the textentry.
xdt:setPos(nn) Sets the position.
xdt:setPos(xv2) Sets the position.
xdt:getPos(e) Returns the position.
xdt:setSize(nn) Sets the size.
xdt:setSize(xv2) Sets the size.
xdt:getSize(e) Returns the size.
xdt:setWidth(n) Sets only the width.
xdt:getWidth(e) Returns the width.
xdt:setHeight(n) Sets only the height.
xdt:getHeight(e) Returns the height.
xdt:setVisible(n) Sets whether or not the the element is visible.
xdt:setVisible(ne) Sets whether or not the the element is visible only for the provided player. This function automatically calls modify internally.
xdt:isVisible(e) Returns whether or not the the element is visible.
xdt:dock(n) Sets the docking mode. See DOCK* constants.
xdt:dockMargin(nnnn) Sets the margin when docked.
xdt:dockPadding(nnnn) Sets the padding when docked.
xdt:create() Creates the element for every player in the player list.
xdt:create(r) Creates the element for every player in the provided list
xdt:modify() Applies all changes made to the element for every player in the player's list. Does not create the element again if it got removed!.
xdt:modify(r) Applies all changes made to the element for every player in the provided list. Does not create the element again if it got removed!.
xdt:closePlayer(e) Closes the element on the specified player but keeps the player inside the element's player list. (Also see remove(E))
xdt:closeAll() Closes the element on all players in the player's list. Keeps the players inside the element's player list. (Also see removeAll())
xdt:addPlayer(e) Adds a player to the element's player list. These players will see the object when it's created or modified (see create()/modify()).
xdt:removePlayer(e) Removes a player from the elements's player list.
xdt:remove(e) Removes this element only on the specified player and also removes the player from the element's player list. (e.g. calling create() again won't target this player anymore)
xdt:removeAll() Removes this element from all players in the player list and clears the element's player list.
xdt:getPlayers() Retrieve the current player list of this element.
xdt:setPlayers(r) Sets the player list for this element.

dspawnicon(xdi)

Function Description
xdi:setEnabled(n) Enables/disables the SpawnIcon.
xdi:setModel(s) Sets the model of the SpawnIcon
xdi:getEnabled(e) Returns if the SpawnIcon is disabled or not.
xdi:getModel(e) Returns the model of the SpawnIcon.
xdi:setPos(nn) Sets the position.
xdi:setPos(xv2) Sets the position.
xdi:getPos(e) Returns the position.
xdi:setSize(nn) Sets the size.
xdi:setSize(xv2) Sets the size.
xdi:getSize(e) Returns the size.
xdi:setWidth(n) Sets only the width.
xdi:getWidth(e) Returns the width.
xdi:setHeight(n) Sets only the height.
xdi:getHeight(e) Returns the height.
xdi:setVisible(n) Sets whether or not the the element is visible.
xdi:setVisible(ne) Sets whether or not the the element is visible only for the provided player. This function automatically calls modify internally.
xdi:isVisible(e) Returns whether or not the the element is visible.
xdi:dock(n) Sets the docking mode. See DOCK* constants.
xdi:dockMargin(nnnn) Sets the margin when docked.
xdi:dockPadding(nnnn) Sets the padding when docked.
xdi:create() Creates the element for every player in the player list.
xdi:create(r) Creates the element for every player in the provided list
xdi:modify() Applies all changes made to the element for every player in the player's list. Does not create the element again if it got removed!.
xdi:modify(r) Applies all changes made to the element for every player in the provided list. Does not create the element again if it got removed!.
xdi:closePlayer(e) Closes the element on the specified player but keeps the player inside the element's player list. (Also see remove(E))
xdi:closeAll() Closes the element on all players in the player's list. Keeps the players inside the element's player list. (Also see removeAll())
xdi:addPlayer(e) Adds a player to the element's player list. These players will see the object when it's created or modified (see create()/modify()).
xdi:removePlayer(e) Removes a player from the elements's player list.
xdi:remove(e) Removes this element only on the specified player and also removes the player from the element's player list. (e.g. calling create() again won't target this player anymore)
xdi:removeAll() Removes this element from all players in the player list and clears the element's player list.
xdi:getPlayers() Retrieve the current player list of this element.
xdi:setPlayers(r) Sets the player list for this element.

dslider(xds)

Function Description
xds:setColor(v) Sets the color.
xds:setColor(vn) Sets the color.
xds:setColor(xv4) Sets the color.
xds:setColor(nnn) Sets the color.
xds:setColor(nnnn) Sets the color.
xds:setText(s) Sets the text of the Slider.
xds:setMin(n) Sets the minimum Value
xds:setMax(n) Sets the maximum Value.
xds:setDecimals(n) Hides the close Slider.
xds:setValue(n) Set the curren Slider Value.
xds:setDark(n) Sets the Theme of the Slider to the dark Theme.
xds:getColor(e) Returns the color.
xds:getColor4(e) Returns the color.
xds:getValue(e) Gets the current slider value.
xds:getMin(e) Returns the minimum value.
xds:getMax(e) Returns the maximum value.
xds:setPos(nn) Sets the position.
xds:setPos(xv2) Sets the position.
xds:getPos(e) Returns the position.
xds:setSize(nn) Sets the size.
xds:setSize(xv2) Sets the size.
xds:getSize(e) Returns the size.
xds:setWidth(n) Sets only the width.
xds:getWidth(e) Returns the width.
xds:setHeight(n) Sets only the height.
xds:getHeight(e) Returns the height.
xds:setVisible(n) Sets whether or not the the element is visible.
xds:setVisible(ne) Sets whether or not the the element is visible only for the provided player. This function automatically calls modify internally.
xds:isVisible(e) Returns whether or not the the element is visible.
xds:dock(n) Sets the docking mode. See DOCK* constants.
xds:dockMargin(nnnn) Sets the margin when docked.
xds:dockPadding(nnnn) Sets the padding when docked.
xds:create() Creates the element for every player in the player list.
xds:create(r) Creates the element for every player in the provided list
xds:modify() Applies all changes made to the element for every player in the player's list. Does not create the element again if it got removed!.
xds:modify(r) Applies all changes made to the element for every player in the provided list. Does not create the element again if it got removed!.
xds:closePlayer(e) Closes the element on the specified player but keeps the player inside the element's player list. (Also see remove(E))
xds:closeAll() Closes the element on all players in the player's list. Keeps the players inside the element's player list. (Also see removeAll())
xds:addPlayer(e) Adds a player to the element's player list. These players will see the object when it's created or modified (see create()/modify()).
xds:removePlayer(e) Removes a player from the elements's player list.
xds:remove(e) Removes this element only on the specified player and also removes the player from the element's player list. (e.g. calling create() again won't target this player anymore)
xds:removeAll() Removes this element from all players in the player list and clears the element's player list.
xds:getPlayers() Retrieve the current player list of this element.
xds:setPlayers(r) Sets the player list for this element.

dpropertysheet(xdo)

Function Description
xdo:setColor(v) Sets the color of the panel.
xdo:setColor(vn) Sets the color of the panel.
xdo:setColor(xv4) Sets the color of the panel.
xdo:setColor(nnn) Sets the color of the panel.
xdo:setColor(nnnn) Sets the color of the panel.
xdo:addSheet(sxdp) name,panel,icon(material name or icon) Adds a new tab.Icon names can be found here: http://wiki.garrysmod.com/page/Silkicons Note: use "icon16/.png" as material name for icons. E.g. "icon16/accept.png"
xdo:closeTab(s) Closes the tab with the given name.
xdo:getColor(e) Returns the color of the panel.
xdo:getColor4(e) Returns the color of the panel.
xdo:getColor4(e) Returns the color of the panel.
xdo:setPos(nn) Sets the position.
xdo:setPos(xv2) Sets the position.
xdo:getPos(e) Returns the position.
xdo:setSize(nn) Sets the size.
xdo:setSize(xv2) Sets the size.
xdo:getSize(e) Returns the size.
xdo:setWidth(n) Sets only the width.
xdo:getWidth(e) Returns the width.
xdo:setHeight(n) Sets only the height.
xdo:getHeight(e) Returns the height.
xdo:setVisible(n) Sets whether or not the the element is visible.
xdo:setVisible(ne) Sets whether or not the the element is visible only for the provided player. This function automatically calls modify internally.
xdo:isVisible(e) Returns whether or not the the element is visible.
xdo:dock(n) Sets the docking mode. See DOCK* constants.
xdo:dockMargin(nnnn) Sets the margin when docked.
xdo:dockPadding(nnnn) Sets the padding when docked.
xdo:create() Creates the element for every player in the player list.
xdo:create(r) Creates the element for every player in the provided list
xdo:modify() Applies all changes made to the element for every player in the player's list. Does not create the element again if it got removed!.
xdo:modify(r) Applies all changes made to the element for every player in the provided list. Does not create the element again if it got removed!.
xdo:closePlayer(e) Closes the element on the specified player but keeps the player inside the element's player list. (Also see remove(E))
xdo:closeAll() Closes the element on all players in the player's list. Keeps the players inside the element's player list. (Also see removeAll())
xdo:addPlayer(e) Adds a player to the element's player list. These players will see the object when it's created or modified (see create()/modify()).
xdo:removePlayer(e) Removes a player from the elements's player list.
xdo:remove(e) Removes this element only on the specified player and also removes the player from the element's player list. (e.g. calling create() again won't target this player anymore)
xdo:removeAll() Removes this element from all players in the player list and clears the element's player list.
xdo:getPlayers() Retrieve the current player list of this element.
xdo:setPlayers(r) Sets the player list for this element.

dpanel(xdp)

Function Description
xdp:center() Centers the panel.
xdp:setColor(v) Sets the color of the Panel.
xdp:setColor(vn) Sets the color of the Panel.
xdp:setColor(xv4) Sets the color of the Panel.
xdp:setColor(nnn) Sets the color of the Panel.
xdp:setColor(nnnn) Sets the color of the Panel.
xdp:getColor(e) Returns the color of the Panel.
xdp:getColor4(e) Returns the color of the Panel.
xdp:setPos(nn) Sets the position.
xdp:setPos(xv2) Sets the position.
xdp:getPos(e) Returns the position.
xdp:setSize(nn) Sets the size.
xdp:setSize(xv2) Sets the size.
xdp:getSize(e) Returns the size.
xdp:setWidth(n) Sets only the width.
xdp:getWidth(e) Returns the width.
xdp:setHeight(n) Sets only the height.
xdp:getHeight(e) Returns the height.
xdp:setVisible(n) Sets whether or not the the element is visible.
xdp:setVisible(ne) Sets whether or not the the element is visible only for the provided player. This function automatically calls modify internally.
xdp:isVisible(e) Returns whether or not the the element is visible.
xdp:dock(n) Sets the docking mode. See DOCK* constants.
xdp:dockMargin(nnnn) Sets the margin when docked.
xdp:dockPadding(nnnn) Sets the padding when docked.
xdp:create() Creates the element for every player in the player list.
xdp:create(r) Creates the element for every player in the provided list
xdp:modify() Applies all changes made to the element for every player in the player's list. Does not create the element again if it got removed!.
xdp:modify(r) Applies all changes made to the element for every player in the provided list. Does not create the element again if it got removed!.
xdp:closePlayer(e) Closes the element on the specified player but keeps the player inside the element's player list. (Also see remove(E))
xdp:closeAll() Closes the element on all players in the player's list. Keeps the players inside the element's player list. (Also see removeAll())
xdp:addPlayer(e) Adds a player to the element's player list. These players will see the object when it's created or modified (see create()/modify()).
xdp:removePlayer(e) Removes a player from the elements's player list.
xdp:remove(e) Removes this element only on the specified player and also removes the player from the element's player list. (e.g. calling create() again won't target this player anymore)
xdp:removeAll() Removes this element from all players in the player list and clears the element's player list.
xdp:getPlayers() Retrieve the current player list of this element.
xdp:setPlayers(r) Sets the player list for this element.

dmodelpanel(xdk)

Function Description
xdk:setColor(v) Sets the color.
xdk:setColor(vn) Sets the color.
xdk:setColor(nnn) Sets the color.
xdk:setColor(nnnn) Sets the color.
xdk:setModel(s) Sets the model.
xdk:setFOV(s) Sets the FOV.
xdk:setCamPos(v) Sets the position of the camera.
xdk:setLookAt(v) Makes the panel's camera face the given position.
xdk:setLookAng(v) Sets the angles of the camera.
xdk:autoAdjust() Tries to adjust the cam position and directon automatically. Can only be called before the panel gets created (with create()), it has no impact if called after creation.
xdk:setRotateModel(n) Rotates the model slowly.
xdk:setAmbientLight(v) Sets the ambient light color.
xdk:setAmbientLight(nnn) Sets the ambient light color.
xdk:setAnimated(n) Enables the animation for the model. (e.g. player model will walk)
xdk:setDirectionalLight(nv) Creates a directional light and sets the color and direction. Use BOX* constants to set the direction.
xdk:setDrawOutlinedRect(v) Draws an outlined rectangle around the model panel.
xdk:setDrawOutlinedRect(xv4) Draws an outlined rectangle around the model panel.
xdk:getModel(e) Returns the model.
xdk:getColor(e) Returns the color.
xdk:getColor4(e) Returns the color.
xdk:setPos(nn) Sets the position.
xdk:setPos(xv2) Sets the position.
xdk:getPos(e) Returns the position.
xdk:setSize(nn) Sets the size.
xdk:setSize(xv2) Sets the size.
xdk:getSize(e) Returns the size.
xdk:setWidth(n) Sets only the width.
xdk:getWidth(e) Returns the width.
xdk:setHeight(n) Sets only the height.
xdk:getHeight(e) Returns the height.
xdk:setVisible(n) Sets whether or not the the element is visible.
xdk:setVisible(ne) Sets whether or not the the element is visible only for the provided player. This function automatically calls modify internally.
xdk:isVisible(e) Returns whether or not the the element is visible.
xdk:dock(n) Sets the docking mode. See DOCK* constants.
xdk:dockMargin(nnnn) Sets the margin when docked.
xdk:dockPadding(nnnn) Sets the padding when docked.
xdk:create() Creates the element for every player in the player list.
xdk:create(r) Creates the element for every player in the provided list
xdk:modify() Applies all changes made to the element for every player in the player's list. Does not create the element again if it got removed!.
xdk:modify(r) Applies all changes made to the element for every player in the provided list. Does not create the element again if it got removed!.
xdk:closePlayer(e) Closes the element on the specified player but keeps the player inside the element's player list. (Also see remove(E))
xdk:closeAll() Closes the element on all players in the player's list. Keeps the players inside the element's player list. (Also see removeAll())
xdk:addPlayer(e) Adds a player to the element's player list. These players will see the object when it's created or modified (see create()/modify()).
xdk:removePlayer(e) Removes a player from the elements's player list.
xdk:remove(e) Removes this element only on the specified player and also removes the player from the element's player list. (e.g. calling create() again won't target this player anymore)
xdk:removeAll() Removes this element from all players in the player list and clears the element's player list.
xdk:getPlayers() Retrieve the current player list of this element.
xdk:setPlayers(r) Sets the player list for this element.

dlistview(xdv)

Function Description
xdv:addColumn(s) Adds a column to the listview.
xdv:addColumn(sn) Adds a column to the listview. If width is 0, it will autosize to fill the space.
xdv:addColumn(snn) Adds a column to the listview. if width is 0, it will autosize to fill the space. For the position, order of operation matters here, adding columns with the wrong position index can cause LUA errors.
xdv:addLine() Adds a line to the list listview. (Hardcoded max of 200 lines)
xdv:setMultiSelect(n) Sets whether multiple lines can be selected by the user by using the ctrl or shift key
xdv:getIndex(e) Returns the selected index.
xdv:getValues(e) Returns the selected values.
xdv:clear() Clears the listview.
xdv:removeLine(n) Remove the line.
xdv:sortByColumn(nn) Sort by a column.
xdv:setPos(nn) Sets the position.
xdv:setPos(xv2) Sets the position.
xdv:getPos(e) Returns the position.
xdv:setSize(nn) Sets the size.
xdv:setSize(xv2) Sets the size.
xdv:getSize(e) Returns the size.
xdv:setWidth(n) Sets only the width.
xdv:getWidth(e) Returns the width.
xdv:setHeight(n) Sets only the height.
xdv:getHeight(e) Returns the height.
xdv:setVisible(n) Sets whether or not the the element is visible.
xdv:setVisible(ne) Sets whether or not the the element is visible only for the provided player. This function automatically calls modify internally.
xdv:isVisible(e) Returns whether or not the the element is visible.
xdv:dock(n) Sets the docking mode. See DOCK* constants.
xdv:dockMargin(nnnn) Sets the margin when docked.
xdv:dockPadding(nnnn) Sets the padding when docked.
xdv:create() Creates the element for every player in the player list.
xdv:create(r) Creates the element for every player in the provided list
xdv:modify() Applies all changes made to the element for every player in the player's list. Does not create the element again if it got removed!.
xdv:modify(r) Applies all changes made to the element for every player in the provided list. Does not create the element again if it got removed!.
xdv:closePlayer(e) Closes the element on the specified player but keeps the player inside the element's player list. (Also see remove(E))
xdv:closeAll() Closes the element on all players in the player's list. Keeps the players inside the element's player list. (Also see removeAll())
xdv:addPlayer(e) Adds a player to the element's player list. These players will see the object when it's created or modified (see create()/modify()).
xdv:removePlayer(e) Removes a player from the elements's player list.
xdv:remove(e) Removes this element only on the specified player and also removes the player from the element's player list. (e.g. calling create() again won't target this player anymore)
xdv:removeAll() Removes this element from all players in the player list and clears the element's player list.
xdv:getPlayers() Retrieve the current player list of this element.
xdv:setPlayers(r) Sets the player list for this element.

dlabel(xdl)

Function Description
xdl:setTextColor(v) Sets the text color.
xdl:setTextColor(vn) Sets the text color.
xdl:setTextColor(xv4) Sets the text color.
xdl:setTextColor(nnn) Sets the text color.
xdl:setTextColor(nnnn) Sets the text color.
xdl:setText(s) Sets the label of the Label.
xdl:setFont(s) Sets the font.
xdl:setFont(sn) Sets the font and fontsize.
xdl:setDrawOutlinedRect(v) Draws an outlined rect around the text with the given color.
xdl:setDrawOutlinedRect(xv4) Draws an outlined rect around the text with the given color.
xdl:setAutoStretchVertical(n) Automatically adjusts the height of the label dependent of the height of the text inside of it.
xdl:setWrap(n) Sets whether text wrapping should be enabled or disabled on label. Use DLabel:SetAutoStretchVertical to automatically correct vertical size.
xdl:getColor(e) Returns the text color.
xdl:getColor4(e) Returns the text color.
xdl:getText(e) Returns the text of the Label.
xdl:setPos(nn) Sets the position.
xdl:setPos(xv2) Sets the position.
xdl:getPos(e) Returns the position.
xdl:setSize(nn) Sets the size.
xdl:setSize(xv2) Sets the size.
xdl:getSize(e) Returns the size.
xdl:setWidth(n) Sets only the width.
xdl:getWidth(e) Returns the width.
xdl:setHeight(n) Sets only the height.
xdl:getHeight(e) Returns the height.
xdl:setVisible(n) Sets whether or not the the element is visible.
xdl:setVisible(ne) Sets whether or not the the element is visible only for the provided player. This function automatically calls modify internally.
xdl:isVisible(e) Returns whether or not the the element is visible.
xdl:dock(n) Sets the docking mode. See DOCK* constants.
xdl:dockMargin(nnnn) Sets the margin when docked.
xdl:dockPadding(nnnn) Sets the padding when docked.
xdl:create() Creates the element for every player in the player list.
xdl:create(r) Creates the element for every player in the provided list
xdl:modify() Applies all changes made to the element for every player in the player's list. Does not create the element again if it got removed!.
xdl:modify(r) Applies all changes made to the element for every player in the provided list. Does not create the element again if it got removed!.
xdl:closePlayer(e) Closes the element on the specified player but keeps the player inside the element's player list. (Also see remove(E))
xdl:closeAll() Closes the element on all players in the player's list. Keeps the players inside the element's player list. (Also see removeAll())
xdl:addPlayer(e) Adds a player to the element's player list. These players will see the object when it's created or modified (see create()/modify()).
xdl:removePlayer(e) Removes a player from the elements's player list.
xdl:remove(e) Removes this element only on the specified player and also removes the player from the element's player list. (e.g. calling create() again won't target this player anymore)
xdl:removeAll() Removes this element from all players in the player list and clears the element's player list.
xdl:getPlayers() Retrieve the current player list of this element.
xdl:setPlayers(r) Sets the player list for this element.

dimagebutton(xib)

Function Description
xib:setColor(v) Sets the color of the button.
xib:setColor(vn) Sets the color of the button.
xib:setColor(xv4) Sets the color of the button.
xib:setColor(nnn) Sets the color of the button.
xib:setColor(nnnn) Sets the color of the button.
xib:setTextColor(vvvv) Sets the text color of the button.
xib:setTextColor(xv4v4xv4v4) Sets the text color of the button.
xib:setText(s) Sets the label. (Is hidden by the image)
xib:setFont(s) Sets the font.
xib:setFont(sn) Sets the font and fontsize.
xib:setEnabled(n) Enables/disables the imagebutton.
xib:setCornerRadius(n) Radius of the rounded corners.
xib:setImage(s) The image to use, relative to '/materials/' Icon names can be found here: http://wiki.garrysmod.com/page/Silkicons Note: use "icon16/.png" as material name for icons. E.g. "icon16/accept.png"
xib:setKeepAspect(n) Sets whether the imagebutton should keep the aspect ratio of its image. Note that this will not try to fit the image inside the button, but instead it will fill the button with the image.
xib:setStretchToFit(n) Sets whether the image inside the imagebutton should be stretched to fill the entire size of the button, without preserving aspect ratio.
xib:getColor(e) Returns the color of the imagebutton.
xib:getColor4(e) Returns the color of the imagebutton.
xib:getText(e) Returns the label of the imagebutton.
xib:getEnabled(e) Returns if the ImageButton is disabled or not.
xib:getImage(e) Returns the image of the imagebutton.
xib:setPos(nn) Sets the position.
xib:setPos(xv2) Sets the position.
xib:getPos(e) Returns the position.
xib:setSize(nn) Sets the size.
xib:setSize(xv2) Sets the size.
xib:getSize(e) Returns the size.
xib:setWidth(n) Sets only the width.
xib:getWidth(e) Returns the width.
xib:setHeight(n) Sets only the height.
xib:getHeight(e) Returns the height.
xib:setVisible(n) Sets whether or not the the element is visible.
xib:setVisible(ne) Sets whether or not the the element is visible only for the provided player. This function automatically calls modify internally.
xib:isVisible(e) Returns whether or not the the element is visible.
xib:dock(n) Sets the docking mode. See DOCK* constants.
xib:dockMargin(nnnn) Sets the margin when docked.
xib:dockPadding(nnnn) Sets the padding when docked.
xib:create() Creates the element for every player in the player list.
xib:create(r) Creates the element for every player in the provided list
xib:modify() Applies all changes made to the element for every player in the player's list. Does not create the element again if it got removed!.
xib:modify(r) Applies all changes made to the element for every player in the provided list. Does not create the element again if it got removed!.
xib:closePlayer(e) Closes the element on the specified player but keeps the player inside the element's player list. (Also see remove(E))
xib:closeAll() Closes the element on all players in the player's list. Keeps the players inside the element's player list. (Also see removeAll())
xib:addPlayer(e) Adds a player to the element's player list. These players will see the object when it's created or modified (see create()/modify()).
xib:removePlayer(e) Removes a player from the elements's player list.
xib:remove(e) Removes this element only on the specified player and also removes the player from the element's player list. (e.g. calling create() again won't target this player anymore)
xib:removeAll() Removes this element from all players in the player list and clears the element's player list.
xib:getPlayers() Retrieve the current player list of this element.
xib:setPlayers(r) Sets the player list for this element.

dframe(xdf)

Function Description
xdf:center() Sets the position of the frame in the center of the screen.
xdf:setColor(v) Sets the color of the frame.
xdf:setColor(vn) Sets the color of the frame.
xdf:setColor(xv4) Sets the color of the frame.
xdf:setColor(nnn) Sets the color of the frame.
xdf:setColor(nnnn) Sets the color of the frame.
xdf:setTitle(s) Set the title of the frame.
xdf:setBackgroundBlur(n) Blurs background behind the frame.
xdf:setIcon(s) The image file to use, relative to '/materials/' Icon names can be found here: http://wiki.garrysmod.com/page/Silkicons Note: use "icon16/.png" as material name for icons. E.g. "icon16/accept.png"
xdf:setSizable(n) Makes the frame resizable.
xdf:showCloseButton(n) Shows or hides the close button.
xdf:setDeleteOnClose(n) Removes the frame when the close button is pressed or simply hides it (setVisible(0)).
xdf:getColor(e) Returns the color of the frame.
xdf:getColor4(e) Returns the color of the frame.
xdf:getTitle(e) Returns the title of the frame
xdf:getSizable(e) Returns if the frame is resizable.
xdf:getShowCloseButton(e) Returns if the close button is visible.
xdf:getDeleteOnClose(e) Returns if the frame gets removed on close.
xdf:makePopup() Makes the frame pop up after using DFrame:create(). See enableMouseInput() and enableKeyboardInput().
xdf:enableMouseInput(n) Enables the mouse input after using DFrame:create().
xdf:enableKeyboardInput(n) Enables the keyboard input after using DFrame:create().
xdf:setPos(nn) Sets the position.
xdf:setPos(xv2) Sets the position.
xdf:getPos(e) Returns the position.
xdf:setSize(nn) Sets the size.
xdf:setSize(xv2) Sets the size.
xdf:getSize(e) Returns the size.
xdf:setWidth(n) Sets only the width.
xdf:getWidth(e) Returns the width.
xdf:setHeight(n) Sets only the height.
xdf:getHeight(e) Returns the height.
xdf:setVisible(n) Sets whether or not the the element is visible.
xdf:setVisible(ne) Sets whether or not the the element is visible only for the provided player. This function automatically calls modify internally.
xdf:isVisible(e) Returns whether or not the the element is visible.
xdf:dock(n) Sets the docking mode. See DOCK* constants.
xdf:dockMargin(nnnn) Sets the margin when docked.
xdf:dockPadding(nnnn) Sets the padding when docked.
xdf:create() Creates the element for every player in the player list.
xdf:create(r) Creates the element for every player in the provided list
xdf:modify() Applies all changes made to the element for every player in the player's list. Does not create the element again if it got removed!.
xdf:modify(r) Applies all changes made to the element for every player in the provided list. Does not create the element again if it got removed!.
xdf:closePlayer(e) Closes the element on the specified player but keeps the player inside the element's player list. (Also see remove(E))
xdf:closeAll() Closes the element on all players in the player's list. Keeps the players inside the element's player list. (Also see removeAll())
xdf:addPlayer(e) Adds a player to the element's player list. These players will see the object when it's created or modified (see create()/modify()).
xdf:removePlayer(e) Removes a player from the elements's player list.
xdf:remove(e) Removes this element only on the specified player and also removes the player from the element's player list. (e.g. calling create() again won't target this player anymore)
xdf:removeAll() Removes this element from all players in the player list and clears the element's player list.
xdf:getPlayers() Retrieve the current player list of this element.
xdf:setPlayers(r) Sets the player list for this element.

dcombobox(xcb)

Function Description
xcb:addChoice(ss) Adds a choice with a string value attached.
xcb:addChoice(sn) Adds a choice with a number value attached.
xcb:addChoice(sxv2) Adds a choice with a vector2 value attached.
xcb:addChoice(sv) Adds a choice with a vector value attached.
xcb:addChoice(sxv4) Adds a choice with a vector4 value attached.
xcb:addChoice(sr) Adds a choice with a array value attached.
xcb:addChoice(st) Adds a choice with a table value attached.
xcb:addChoices(r) Adds a list of choices. Values can be players, entities, strings and numbers. Every other datatype gets ignored.
xcb:addChoices(t) Adds a list of choices. Values can be players, entities, strings and numbers. Every other datatype gets ignored.
xcb:clear() Removes all choices.
xcb:setText(s) Sets the initial text.
xcb:setSortItems(n) Sorts the items alphabetically in the dropdown menu.
xcb:getValue(e) Returns the value.
xcb:getValueID(e) Returns the index of the value.
xcb:getData(e) Returns the data.
xcb:setPos(nn) Sets the position.
xcb:setPos(xv2) Sets the position.
xcb:getPos(e) Returns the position.
xcb:setSize(nn) Sets the size.
xcb:setSize(xv2) Sets the size.
xcb:getSize(e) Returns the size.
xcb:setWidth(n) Sets only the width.
xcb:getWidth(e) Returns the width.
xcb:setHeight(n) Sets only the height.
xcb:getHeight(e) Returns the height.
xcb:setVisible(n) Sets whether or not the the element is visible.
xcb:setVisible(ne) Sets whether or not the the element is visible only for the provided player. This function automatically calls modify internally.
xcb:isVisible(e) Returns whether or not the the element is visible.
xcb:dock(n) Sets the docking mode. See DOCK* constants.
xcb:dockMargin(nnnn) Sets the margin when docked.
xcb:dockPadding(nnnn) Sets the padding when docked.
xcb:create() Creates the element for every player in the player list.
xcb:create(r) Creates the element for every player in the provided list
xcb:modify() Applies all changes made to the element for every player in the player's list. Does not create the element again if it got removed!.
xcb:modify(r) Applies all changes made to the element for every player in the provided list. Does not create the element again if it got removed!.
xcb:closePlayer(e) Closes the element on the specified player but keeps the player inside the element's player list. (Also see remove(E))
xcb:closeAll() Closes the element on all players in the player's list. Keeps the players inside the element's player list. (Also see removeAll())
xcb:addPlayer(e) Adds a player to the element's player list. These players will see the object when it's created or modified (see create()/modify()).
xcb:removePlayer(e) Removes a player from the elements's player list.
xcb:remove(e) Removes this element only on the specified player and also removes the player from the element's player list. (e.g. calling create() again won't target this player anymore)
xcb:removeAll() Removes this element from all players in the player list and clears the element's player list.
xcb:getPlayers() Retrieve the current player list of this element.
xcb:setPlayers(r) Sets the player list for this element.

dcolormixer(xde)

Function Description
xde:setColor(v) Sets the default color
xde:setColor(vn) Sets the default color
xde:setColor(xv4) Sets the default color
xde:setColor(nnn) Sets the default color
xde:setColor(nnnn) Sets the default color
xde:setText(s) Sets the label's text.
xde:showPalette(n) Show/hide the palette panel.
xde:showAlphaBar(n) Show/Hide the alpha bar.
xde:showWangs(n) Show/Hide the color indicators.
xde:getColor(e) Returns the current selected color.
xde:getColor4(e) Returns the current selected color.
xde:setPos(nn) Sets the position.
xde:setPos(xv2) Sets the position.
xde:getPos(e) Returns the position.
xde:setSize(nn) Sets the size.
xde:setSize(xv2) Sets the size.
xde:getSize(e) Returns the size.
xde:setWidth(n) Sets only the width.
xde:getWidth(e) Returns the width.
xde:setHeight(n) Sets only the height.
xde:getHeight(e) Returns the height.
xde:setVisible(n) Sets whether or not the the element is visible.
xde:setVisible(ne) Sets whether or not the the element is visible only for the provided player. This function automatically calls modify internally.
xde:isVisible(e) Returns whether or not the the element is visible.
xde:dock(n) Sets the docking mode. See DOCK* constants.
xde:dockMargin(nnnn) Sets the margin when docked.
xde:dockPadding(nnnn) Sets the padding when docked.
xde:create() Creates the element for every player in the player list.
xde:create(r) Creates the element for every player in the provided list
xde:modify() Applies all changes made to the element for every player in the player's list. Does not create the element again if it got removed!.
xde:modify(r) Applies all changes made to the element for every player in the provided list. Does not create the element again if it got removed!.
xde:closePlayer(e) Closes the element on the specified player but keeps the player inside the element's player list. (Also see remove(E))
xde:closeAll() Closes the element on all players in the player's list. Keeps the players inside the element's player list. (Also see removeAll())
xde:addPlayer(e) Adds a player to the element's player list. These players will see the object when it's created or modified (see create()/modify()).
xde:removePlayer(e) Removes a player from the elements's player list.
xde:remove(e) Removes this element only on the specified player and also removes the player from the element's player list. (e.g. calling create() again won't target this player anymore)
xde:removeAll() Removes this element from all players in the player list and clears the element's player list.
xde:getPlayers() Retrieve the current player list of this element.
xde:setPlayers(r) Sets the player list for this element.

dcheckboxlabel(xbl)

Function Description
xbl:setText(s) Sets the text for the checkbox.
xbl:setChecked(n) Sets whether or not the checkbox is checked.
xbl:setIndent(n) Sets the indentation of the element on the X axis.
xbl:getText(e) Returns the text of the checkbox.
xbl:getChecked(e) Returns whether or not the checkbox is checked.
xbl:getIndent(e) Returns the indentation of the element.
xbl:setPos(nn) Sets the position.
xbl:setPos(xv2) Sets the position.
xbl:getPos(e) Returns the position.
xbl:setSize(nn) Sets the size.
xbl:setSize(xv2) Sets the size.
xbl:getSize(e) Returns the size.
xbl:setWidth(n) Sets only the width.
xbl:getWidth(e) Returns the width.
xbl:setHeight(n) Sets only the height.
xbl:getHeight(e) Returns the height.
xbl:setVisible(n) Sets whether or not the the element is visible.
xbl:setVisible(ne) Sets whether or not the the element is visible only for the provided player. This function automatically calls modify internally.
xbl:isVisible(e) Returns whether or not the the element is visible.
xbl:dock(n) Sets the docking mode. See DOCK* constants.
xbl:dockMargin(nnnn) Sets the margin when docked.
xbl:dockPadding(nnnn) Sets the padding when docked.
xbl:create() Creates the element for every player in the player list.
xbl:create(r) Creates the element for every player in the provided list
xbl:modify() Applies all changes made to the element for every player in the player's list. Does not create the element again if it got removed!.
xbl:modify(r) Applies all changes made to the element for every player in the provided list. Does not create the element again if it got removed!.
xbl:closePlayer(e) Closes the element on the specified player but keeps the player inside the element's player list. (Also see remove(E))
xbl:closeAll() Closes the element on all players in the player's list. Keeps the players inside the element's player list. (Also see removeAll())
xbl:addPlayer(e) Adds a player to the element's player list. These players will see the object when it's created or modified (see create()/modify()).
xbl:removePlayer(e) Removes a player from the elements's player list.
xbl:remove(e) Removes this element only on the specified player and also removes the player from the element's player list. (e.g. calling create() again won't target this player anymore)
xbl:removeAll() Removes this element from all players in the player list and clears the element's player list.
xbl:getPlayers() Retrieve the current player list of this element.
xbl:setPlayers(r) Sets the player list for this element.

dcheckbox(xdc)

Function Description
xdc:setChecked(n) Sets whether or not the checkbox is checked.
xdc:getChecked(e) Returns whether or not the checkbox is checked.
xdc:setPos(nn) Sets the position.
xdc:setPos(xv2) Sets the position.
xdc:getPos(e) Returns the position.
xdc:setSize(nn) Sets the size.
xdc:setSize(xv2) Sets the size.
xdc:getSize(e) Returns the size.
xdc:setWidth(n) Sets only the width.
xdc:getWidth(e) Returns the width.
xdc:setHeight(n) Sets only the height.
xdc:getHeight(e) Returns the height.
xdc:setVisible(n) Sets whether or not the the element is visible.
xdc:setVisible(ne) Sets whether or not the the element is visible only for the provided player. This function automatically calls modify internally.
xdc:isVisible(e) Returns whether or not the the element is visible.
xdc:dock(n) Sets the docking mode. See DOCK* constants.
xdc:dockMargin(nnnn) Sets the margin when docked.
xdc:dockPadding(nnnn) Sets the padding when docked.
xdc:create() Creates the element for every player in the player list.
xdc:create(r) Creates the element for every player in the provided list
xdc:modify() Applies all changes made to the element for every player in the player's list. Does not create the element again if it got removed!.
xdc:modify(r) Applies all changes made to the element for every player in the provided list. Does not create the element again if it got removed!.
xdc:closePlayer(e) Closes the element on the specified player but keeps the player inside the element's player list. (Also see remove(E))
xdc:closeAll() Closes the element on all players in the player's list. Keeps the players inside the element's player list. (Also see removeAll())
xdc:addPlayer(e) Adds a player to the element's player list. These players will see the object when it's created or modified (see create()/modify()).
xdc:removePlayer(e) Removes a player from the elements's player list.
xdc:remove(e) Removes this element only on the specified player and also removes the player from the element's player list. (e.g. calling create() again won't target this player anymore)
xdc:removeAll() Removes this element from all players in the player list and clears the element's player list.
xdc:getPlayers() Retrieve the current player list of this element.
xdc:setPlayers(r) Sets the player list for this element.

dbutton(xdb)

Function Description
xdb:setColor(v) Sets the color of the button.
xdb:setColor(vn) Sets the color of the button.
xdb:setColor(xv4) Sets the color of the button.
xdb:setColor(nnn) Sets the color of the button.
xdb:setColor(nnnn) Sets the color of the button.
xdb:setTextColor(vvvv) Sets the color for each corresponding state of the button.
xdb:setTextColor(xv4v4xv4v4) Sets the color for each corresponding state of the button.
xdb:setText(s) Sets the label of the button.
xdb:setFont(s) Sets the font of the text.
xdb:setFont(sn) Sets the font and fontsize of the text.
xdb:setCornerRadius(n) Radius of the rounded corners, works best with a multiple of 2.
xdb:setIcon(s) The image file to use, relative to '/materials/' Icon names can be found here: http://wiki.garrysmod.com/page/Silkicons Note: use "icon16/.png" as material name for icons. E.g. "icon16/accept.png"
xdb:setEnabled(n) Enables/disables the button.
xdb:getColor(e) Returns the color of the button.
xdb:getColor4(e) Returns the color of the button.
xdb:getText(e) Returns the label of the button.
xdb:getEnabled(e) Returns if the button is disabled or not.
xdb:setPos(nn) Sets the position.
xdb:setPos(xv2) Sets the position.
xdb:getPos(e) Returns the position.
xdb:setSize(nn) Sets the size.
xdb:setSize(xv2) Sets the size.
xdb:getSize(e) Returns the size.
xdb:setWidth(n) Sets only the width.
xdb:getWidth(e) Returns the width.
xdb:setHeight(n) Sets only the height.
xdb:getHeight(e) Returns the height.
xdb:setVisible(n) Sets whether or not the the element is visible.
xdb:setVisible(ne) Sets whether or not the the element is visible only for the provided player. This function automatically calls modify internally.
xdb:isVisible(e) Returns whether or not the the element is visible.
xdb:dock(n) Sets the docking mode. See DOCK* constants.
xdb:dockMargin(nnnn) Sets the margin when docked.
xdb:dockPadding(nnnn) Sets the padding when docked.
xdb:create() Creates the element for every player in the player list.
xdb:create(r) Creates the element for every player in the provided list
xdb:modify() Applies all changes made to the element for every player in the player's list. Does not create the element again if it got removed!.
xdb:modify(r) Applies all changes made to the element for every player in the provided list. Does not create the element again if it got removed!.
xdb:closePlayer(e) Closes the element on the specified player but keeps the player inside the element's player list. (Also see remove(E))
xdb:closeAll() Closes the element on all players in the player's list. Keeps the players inside the element's player list. (Also see removeAll())
xdb:addPlayer(e) Adds a player to the element's player list. These players will see the object when it's created or modified (see create()/modify()).
xdb:removePlayer(e) Removes a player from the elements's player list.
xdb:remove(e) Removes this element only on the specified player and also removes the player from the element's player list. (e.g. calling create() again won't target this player anymore)
xdb:removeAll() Removes this element from all players in the player list and clears the element's player list.
xdb:getPlayers() Retrieve the current player list of this element.
xdb:setPlayers(r) Sets the player list for this element.

Missing Descriptions [Work in Progress]

These are E2 functions that are still missing a description. The functions get extracted automatically so some functions might be missing.
Function File path
dpropertysheet:addSheet(string name,xdp panel,string icon) e2_vgui_core\lua\entities\gmod_wire_expression2\core\custom\vgui_elements\server\dpropertysheet.lua
test() e2_vgui_core\lua\entities\gmod_wire_expression2\core\custom\vgui_elements\server\defaultdermafunctions.lua
Clone this wiki locally