This repository has been archived by the owner on Oct 22, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 123
VRage.Game.ModAPI.Ingame.Utilities.TextPtr
Morten Aune Lyrstad edited this page Apr 16, 2022
·
43 revisions
← Index ← Namespace Index
public struct TextPtrA parser utility structure representing a pointer to a location within a string.
Namespace: VRage.Game.ModAPI.Ingame.Utilities
Assembly: VRage.Game.dll
| Member | Description |
|---|---|
| string Content | The original content string |
| int Index | The index being pointed at by this structure |
| Member | Description |
|---|---|
| char Char { get; } | Returns the character currently being pointed at, or\0if out of bounds |
| bool IsEmpty { get; } | Determines whether this pointer is an empty pointer, i.e. not pointing at anything at all. |
| Member | Description |
|---|---|
| TextPtr(string) | |
| TextPtr(string, int) |
| Member | Description |
|---|---|
| TextPtr Find(string) | Finds the given text string |
| TextPtr Find(char) | Finds the given character |
| TextPtr FindAny(Char[]) | Finds one of the given characters |
| TextPtr FindAnyInLine(Char[]) | Finds one of the given characters within the current line |
| TextPtr FindEndOfLine(bool = default) | Finds the end of the current line |
| TextPtr FindInLine(char) | Finds the given character within the current line |
| int FindLineNo() | Determines what line number this pointer is currently at. |
| bool IsEndOfLine() | Determines whether the pointer is currently at the end of a line (right before a newline character set or end of the string) |
| bool IsNewLine() | Determines whether the pointer is currently at a newline (end of the string is not a newline) |
| bool IsOutOfBounds() | Determines whether this pointer is currently out of bounds (before or after the string content) |
| bool IsStartOfLine() | Determines whether the pointer is currently at the beginning of a line (right after a newline character set or start of the string) |
| TextPtr SkipWhitespace(bool = default) | Skips whitespace |
| bool StartsWith(string) | Determines if the current pointer location starts with the given string - in a case sensitive manner. |
| bool StartsWithCaseInsensitive(string) | Determines if the current pointer location starts with the given string - in a case insensitive manner. |
| TextPtr TrimEnd() | Reverses the pointer location until all whitespace is skipped - does not skip newlines |
| TextPtr TrimStart() | Advances the pointer location until all whitespace is skipped - does not skip newlines |
Do you have questions, comments, suggestions for improvements? Is there something I can do better? Did I make a mistake? Please add an issue here, and prefix your issue title with Wiki. Thank you, your help will be very appreciated!