Template:DGS/OOP

From Multi Theft Auto: Wiki
Revision as of 17:03, 19 April 2021 by Lettify (talk | contribs) (little correction)
Jump to navigation Jump to search

Applications-office.pngTemplate Documentation

Template for OOP (object orientated programming)

Usage

Syntax

{{DGS/OOP|NOTE|METHOD|EVENT|VARIABLE|COUNTERPART|ELEMENT_TYPE|ELEMENT_NAME}}

For functions

DGS OOP Syntax Help! I don't understand this!

Note: This function creates a 3d interface in the world.
Method: dgs3DInterface(...)
{{DGS/OOP|This function creates a 3d interface in the world.|dgs3DInterface||}}

DGS OOP Syntax Help! I don't understand this!

Method: DGSElement:setText(...)
Variable: .text
Counterpart: dgsGetText
{{DGS/OOP||DGSElement:setText||text|dgsGetText}}

DGS OOP Syntax Help! I don't understand this!

Note: This function is used to create columns in grid lists.
Method: DGSGridList : addColumn(...)
Counterpart: dgsGridListRemoveColumn
{{DGS/OOP|This function is used to create columns in grid lists.|addColumn|||dgsGridListRemoveColumn|dgs-dxgridlist|GridList}}

For events

DGS OOP Syntax Help! I don't understand this!

Note: This event is triggered each time a DGS element gains input focus
Event: DGSElement : on("dgsFocus", ...)
{{DGS/OOP|This event is triggered each time a DGS element gains input focus||dgsFocus}}

DGS OOP Syntax Help! I don't understand this!

Note: This event is triggered when enter is pressed on a dgs edit box.
Event: DGSEditBox : on("dgsEditAccepted", ...)
{{DGS/OOP|This event is triggered when enter is pressed on a dgs edit box.||dgsEditAccepted|||dgs-dxedit|DGSEditBox}}

Hey guys, here are a few "rules" in using the OOP template:

  • If it's a constructor, such as createPed, use "Ped" not "createPed" or "Ped.create"
  • If it's a static class function or a constructor, use a capital letter for the first character. (Player not player).
  • Likewise, if it's an object function such as "player:setName", use lowercase.
  • Use full stops (or if you're american, "periods.") for static functions and colons (:) for object functions.