# Clear Path Display Waypoints

Grammar — Clears all waypoints for path pathDisplay
Flags — Native | Action

# Arguments

• int<path> — Path Display

Returns — void

native void PathClearWayPoints(int inPathId);

# Related

Category: UI / Path Display

• Create Path Display For Unit — int<path> — PathCreateForUnit
• Create Path Display For Unit Type — int<path> — PathCreateForUnitType
• Last Path Display Created — int<path> — PathLastCreated
• Destroy Path Display — void — PathDestroy
• Destroy Path Displays For Players — void — PathDestroyAll
• Set Path Display Destination Point — void — PathSetDestinationPoint
• Get Path Display Destination Point — point — PathGetDestinationPoint
• Set Path Display Destination Unit — void — PathSetDestinationUnit
• Get Path Display Destination Unit — unit — PathGetDestinationUnit
• Set Path Display Source Point — void — PathSetSourcePoint
• Get Path Display Source Point — point — PathGetSourcePoint
• Set Path Display Source Unit — void — PathSetSourceUnit
• Get Path Display Source Unit — unit — PathGetSourceUnit
• Get Path Display Unit — unit — PathGetUnit
• Get Path Display Unit Type — string<gamelink::Unit> — PathGetUnitType
• Set Path Display Line Texture — void — PathSetLineTexture
• Get Path Display Line Texture — string<filepath> — PathGetLineTexture
• Set Path Display Line Tile Length — void — PathSetLineTileLength
• Get Path Display Line Tile Length — fixed — PathGetLineTileLength
• Set Path Display Line Width — void — PathSetLineWidth
• Get Path Display Line Width — fixed — PathGetLineWidth
• Set Path Display Step Midpoint — void — PathSetStepMidpoint
• Get Path Display Step Midpoint — fixed — PathGetStepMidpoint
• Set Path Display Step Model — void — PathSetStepModel
• Get Path Display Step Model — string<filepath> — PathGetStepModel
• Set Path Display Step Model Scale — void — PathSetStepModelScale
• Get Path Display Step Model Scale — fixed — PathGetStepModelScale
• Set Path Display Color — void — PathSetColor
• Get Path Display Color — color — PathGetColor
• Set Path Display Visibility — void — PathSetVisible
• Get Path Display Visibility — bool<preset::VisibleHiddenOption> — PathGetVisible
• Set Path Display Abil Class Filter — void — PathSetAbilClassFilter
• Clear Path Display Waypoints — void — PathClearWayPoints
• Add Path Display Waypoint — void — PathAddWayPoint
• Set Path Display Minimum Linear Distance — void — PathSetMinimumLinearDistance
• Get Path Display Minimum Linear Distance — fixed — PathGetMinimumLinearDistance
• Set Path Display Minimum Travel Distance — void — PathSetMinimumTravelDistance
• Get Path Display Minimum Travel Distance — fixed — PathGetMinimumTravelDistance
• Set Path Display Minimum Turn Count — void — PathSetMinimumStepCount
• Get Path Display Minimum Turn Count — int — PathGetMinimumStepCount

# Examples

mods/heroesbrawlmods/brawlmapmods/hanamurapayloadpush.stormmod — base.stormdata/LibMHPP.galaxy:282

    // Implementation
    if ((libMHPP_gv_payloadPath.lv_pathDisplay != 0)) {
        PathClearWayPoints(libMHPP_gv_payloadPath.lv_pathDisplay);
        PathDestroy(libMHPP_gv_payloadPath.lv_pathDisplay);
        libMHPP_gv_payloadPath.lv_pathDisplay = 0;

mods/heroesbrawlmods/brawlmapmods/hanamurapayloadpush.stormmod — base.stormdata/LibMHPP.galaxy:323

    // Implementation
    if ((libMHPP_gv_payloadPath.lv_pathDisplay != 0)) {
        PathClearWayPoints(libMHPP_gv_payloadPath.lv_pathDisplay);
        PathDestroy(libMHPP_gv_payloadPath.lv_pathDisplay);
        libMHPP_gv_payloadPath.lv_pathDisplay = 0;

mods/heroesdata.stormmod — base.stormdata/TriggerLibs/MapMechanicsLib.galaxy:2118

    else {
        if ((libMapM_gv_jungleMiniMapPath[lv_mercLanerGroup] != 0)) {
            PathClearWayPoints(libMapM_gv_jungleMiniMapPath[lv_mercLanerGroup]);
            PathDestroy(libMapM_gv_jungleMiniMapPath[lv_mercLanerGroup]);
        }

mods/heroesmapmods/battlegroundmapmods/battlefieldofeternity.stormmod — base.stormdata/LibMLBD.galaxy:1148

            }
            else {
                PathClearWayPoints(libMLBD_gv_mMBOELaningPathLine);
            }
            PathSetSourceUnit(libMLBD_gv_mMBOELaningPathLine, lv_flyPathingLineUnit);

mods/heroesmapmods/battlegroundmapmods/braxisholdout.stormmod — base.stormdata/LibSCHO.galaxy:3104

        libSCHO_gv_mMHO_ZergPathIndexMax[lp_team] = 1;
        if ((libSCHO_gv_mMHO_ZergPaths[lp_team] != 0)) {
            PathClearWayPoints(libSCHO_gv_mMHO_ZergPaths[lp_team]);
            PathDestroy(libSCHO_gv_mMHO_ZergPaths[lp_team]);
        }

mods/heromods/thefirelords.stormmod — base.stormdata/LibHMaj.galaxy:216

    // Implementation
    if ((libHMaj_gv_lavaWaveMiniMapPathId[lp_player][lp_lavaWaveIndex] != 0)) {
        PathClearWayPoints(libHMaj_gv_lavaWaveMiniMapPathId[lp_player][lp_lavaWaveIndex]);
        PathDestroy(libHMaj_gv_lavaWaveMiniMapPathId[lp_player][lp_lavaWaveIndex]);
        libHMaj_gv_lavaWaveMiniMapPathId[lp_player][lp_lavaWaveIndex] = 0;

mods/novastoryassets.sc2mod — base3.sc2maps/maps/campaign/nova/nova09.sc2map/MapScript.galaxy:804

            if ((DistanceBetweenPoints(UnitGetPosition(lp_pathDisplayUnit), PointFromName((lp_pathDisplayID + "-" + IntToString((lv_i + 1))))) < DistanceBetweenPoints(PointFromName((lp_pathDisplayID + "-" + IntToString(lv_i))), PointFromName((lp_pathDisplayID + "-" + IntToString((lv_i + 1))))))) {
                lv_i += 1;
                PathClearWayPoints(gv_hyperionMinimapPathDisplay);
                autoD85986E0_ae = (lp_startingIndex + (lv_waypointCount - 1));
                autoD85986E0_var = lv_i;

mods/novastoryassets.sc2mod/base3.sc2maps/maps/campaign/nova/nova09.sc2map — MapScript.galaxy:804

            if ((DistanceBetweenPoints(UnitGetPosition(lp_pathDisplayUnit), PointFromName((lp_pathDisplayID + "-" + IntToString((lv_i + 1))))) < DistanceBetweenPoints(PointFromName((lp_pathDisplayID + "-" + IntToString(lv_i))), PointFromName((lp_pathDisplayID + "-" + IntToString((lv_i + 1))))))) {
                lv_i += 1;
                PathClearWayPoints(gv_hyperionMinimapPathDisplay);
                autoD85986E0_ae = (lp_startingIndex + (lv_waypointCount - 1));
                autoD85986E0_var = lv_i;