Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
May 26, 2011, 3:44:07 PM (13 years ago)
Author:
anbueche
Message:

comments and license added

File:
1 edited

Legend:

Unmodified
Added
Removed
  • code/branches/portals2/doc/api/groups/Portals.dox

    r8483 r8599  
    33    @ingroup Modules
    44
    5     This module allows you to place @ref modules::PortalEndPoint "PortalEndPoints" in space and connect pairs of them with a @ref modules::PortalLink "PortalLink" in order allow fast travelling from A to B.
     5    This module allows you to place @ref orxonox::PortalEndPoint "PortalEndPoints" in space and connect pairs of them with a @ref orxonox::PortalLink "PortalLink" in order to allow fast travelling from A to B.
    66
    77    @section FastHowTo Fast HowTo: Including portals in a level
     
    5353    @subsection Templates "Templates"
    5454    In order to make @ref orxonox::PortalEndPoint "PortalEndPoints" visible in the game there must be something visible.
    55     The idea above is to define or include arbitrary Templates which make a PortalEndPoint visible and later use them by setting the design attribute of a @ref orxonox::PortalEndPoint "PortalEndPoint" to the template name
     55    The idea (as shown above) is to define or include arbitrary Templates which make a PortalEndPoint visible and use them later by setting the design attribute of a @ref orxonox::PortalEndPoint "PortalEndPoint" to the template name
    5656    @subsection Parameters "Parameters"
    5757     - position: 3d-coordinate in space
    58      - distance (default: 50): distance at which a valid entity gets pulled in by the @ref orxonox::PortalEndPoint (if the end point is an entrance)
     58     - distance (default: 50): distance at which a valid entity gets pulled in (if the end point is an entrance).
    5959     - target (default: "Pawn"): the class which is able to enter this end point (if it is an entrance)
    60      - design: the name of the @ref orxonox::Template "Template" above
     60     - design: the name of the @ref orxonox::Template "design template"
    6161*/
    6262
Note: See TracChangeset for help on using the changeset viewer.