-
-
Notifications
You must be signed in to change notification settings - Fork 631
feat(api-v3): Blip.GetPropertyFlag (public) and Blip.SetPropertyFlag (private) #1628
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
Tivertoni
wants to merge
3
commits into
scripthookvdotnet:main
Choose a base branch
from
Tivertoni:BlipPropertyFlags
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| namespace GTA | ||
| { | ||
| /// <summary> | ||
| /// Flags that define various visual and functional properties of a <see cref="Blip"/>. | ||
| /// </summary> | ||
| public enum BlipPropertyFlag | ||
| { | ||
| /// <summary> | ||
| /// Determines whether a <see cref="Blip"/>'s color is rendered with increased brightness. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// Not all <see cref="BlipColor"/> values are affected. | ||
| /// For example, <see cref="BlipColor.Blue"/> maps internally to <c>HUD_COLOUR_BLUE</c> by default | ||
| /// and switches to <c>HUD_COLOUR_BLUELIGHT</c> when this flag is enabled. | ||
| /// </remarks> | ||
| Brightness = 1, | ||
|
|
||
| /// <summary> | ||
| /// Determines whether a <see cref="Blip"/> will flash at intervals defined by <see cref="Blip.FlashInterval"/>. | ||
| /// </summary> | ||
| Flashing, | ||
|
|
||
| /// <summary> | ||
| /// Indicates whether the <see cref="Blip"/> is visible only at short range. | ||
| /// </summary> | ||
| Shortrange, | ||
|
|
||
| /// <summary> | ||
| /// Determines whether the <see cref="Blip"/> has a GPS route attached to it. | ||
| /// </summary> | ||
| Route, | ||
|
|
||
| /// <summary> | ||
| /// Shows the height indicator arrows on a <see cref="Blip"/>. | ||
| /// </summary> | ||
| ShowHeight, | ||
|
|
||
| /// <summary> | ||
| /// Determines whether markers are drawn at long distances (ideal for high-speed races). | ||
| /// </summary> | ||
| MarkerLongDist, | ||
|
|
||
| /// <summary> | ||
| /// Minimizes the <see cref="Blip"/> when it reaches the edge of the map. | ||
| /// </summary> | ||
| MinimiseOnEdge, | ||
|
|
||
| /// <summary> | ||
| /// Marks the <see cref="Blip"/> as "dead." | ||
| /// </summary> | ||
| Dead, | ||
|
|
||
| /// <summary> | ||
| /// Uses a larger vertical distance threshold before displaying the up/down arrows on the <see cref="Blip"/>. | ||
| /// </summary> | ||
| UseExtendedHeightThreshold, | ||
|
|
||
| /// <summary> | ||
| /// Marks a <see cref="Blip"/> as created for a ped in a relationship group. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// Used in <c>CMiniMap::GetBlipAttachedToEntity</c> to identify blips specifically created for relationship-group peds. | ||
| /// </remarks> | ||
| CreatedForRelationshipGroupPed, | ||
|
|
||
| /// <summary> | ||
| /// Shows a direction cone on the <see cref="Blip"/>. | ||
| /// </summary> | ||
| ShowCone, | ||
|
|
||
| /// <summary> | ||
| /// Indicates that the <see cref="Blip"/> is associated with a mission creator. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// Visually, this behaves similarly to <see cref="MinimiseOnEdge"/>. | ||
| /// However, the <see cref="Blip"/> will not be visible when the exterior map is hidden or when inside an interior. | ||
| /// </remarks> | ||
| MissionCreator, | ||
|
|
||
| /// <summary> | ||
| /// Marks the <see cref="Blip"/> as high detail for the pause map legend. | ||
| /// </summary> | ||
| HighDetail, | ||
|
|
||
| /// <summary> | ||
| /// Hides the <see cref="Blip"/> from the pause map legend. | ||
| /// </summary> | ||
| HiddenOnLegend, | ||
|
|
||
| /// <summary> | ||
| /// Shows a tick indicator on the <see cref="Blip"/>. | ||
| /// </summary> | ||
| ShowTick, | ||
|
|
||
| /// <summary> | ||
| /// Shows a gold tick indicator on the <see cref="Blip"/>. | ||
| /// </summary> | ||
| ShowGoldTick, | ||
|
|
||
| /// <summary> | ||
| /// Shows the "for sale" ($) indicator on the <see cref="Blip"/>. | ||
| /// </summary> | ||
| ShowForSale, | ||
|
|
||
| /// <summary> | ||
| /// Displays the heading/direction indicator on the <see cref="Blip"/>. | ||
| /// </summary> | ||
| ShowHeadingIndicator, | ||
|
|
||
| /// <summary> | ||
| /// Displays an outline indicator on the <see cref="Blip"/>. | ||
| /// </summary> | ||
| ShowOutlineIndicator, | ||
|
|
||
| /// <summary> | ||
| /// Displays the friend indicator on the <see cref="Blip"/>. | ||
| /// </summary> | ||
| ShowFriendIndicator, | ||
|
|
||
| /// <summary> | ||
| /// Displays the crew indicator on the <see cref="Blip"/>. | ||
| /// </summary> | ||
| ShowCrewIndicator, | ||
|
|
||
| /// <summary> | ||
| /// Always shows the height indicator even if the <see cref="Blip"/> is off the edge of the minimap. | ||
| /// </summary> | ||
| UseHeightOnEdge, | ||
|
|
||
| /// <summary> | ||
| /// Marks the <see cref="Blip"/> as being hovered on the pause map. | ||
| /// </summary> | ||
| HoveredOnPausemap, | ||
|
|
||
| /// <summary> | ||
| /// Uses a shorter vertical distance threshold before displaying the up/down arrows on the <see cref="Blip"/>. | ||
| /// </summary> | ||
| UseShortHeightThreshold, | ||
| }; | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This flag isn't present in b2628 or earlier game versions. I tested in both b2628 and b2699 by watching which bit
SHOW_HEADING_INDICATOR_ON_BLIPchanges even.