Template:DGS/OOP

From Multi Theft Auto: Wiki
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 = ?|
    elementType = ?|
    elementName = ?
}}

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|
    Note = This function creates a 3d interface in the world.|
    Method = dgs3DInterface
}}

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

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

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

Note: This function is used to create columns in grid lists.
Method: GridList : addColumn(...)
Counterpart: dgsGridListRemoveColumn
{{DGS/OOP|
    Note = This function is used to create columns in grid lists.|
    Method = addColumn|
    Counterpart = dgsGridListRemoveColumn|
    elementType = dgs-dxgridlist|
    elementName = 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|
    Note = This event is triggered each time a DGS element gains input focus|
    Event = 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|
    Note = This event is triggered when enter is pressed on a dgs edit box.|
    Event = dgsEditAccepted|
    elementType = dgs-dxedit|
    elementName = 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.