Skip to content
This repository has been archived by the owner on Oct 22, 2024. It is now read-only.

VRage.Game.ModAPI.Ingame.Utilities.TextPtr

Morten Aune Lyrstad edited this page Apr 16, 2022 · 43 revisions

IndexNamespace Index

TextPtr Struct

public struct TextPtr

A parser utility structure representing a pointer to a location within a string.

Namespace: VRage.Game.ModAPI.Ingame.Utilities
Assembly: VRage.Game.dll

Fields

Member Description
\$1string Content](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.Content) The original content string
\$1int Index](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.Index) The index being pointed at by this structure

Properties

Member Description
\$1char Char { get; }](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.Char) Returns the character currently being pointed at, or\0if out of bounds
\$1bool IsEmpty { get; }](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.IsEmpty) Determines whether this pointer is an empty pointer, i.e. not pointing at anything at all.

Constructors

Member Description
\$1TextPtr(string)](VRage.Game.ModAPI.Ingame.Utilities.TextPtr..ctor)
\$1TextPtr(string, int)](VRage.Game.ModAPI.Ingame.Utilities.TextPtr..ctor)

Methods

Member Description
\$1TextPtr Find(string)](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.Find) Finds the given text string
\$1TextPtr Find(char)](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.Find) Finds the given character
\$1TextPtr FindAny(Char\$1])](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.FindAny) Finds one of the given characters
\$1TextPtr FindAnyInLine(Char\$1])](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.FindAnyInLine) Finds one of the given characters within the current line
\$1TextPtr FindEndOfLine(\$1bool])](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.FindEndOfLine) Finds the end of the current line
\$1TextPtr FindInLine(char)](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.FindInLine) Finds the given character within the current line
\$1int FindLineNo()](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.FindLineNo) Determines what line number this pointer is currently at.
\$1bool IsEndOfLine()](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.IsEndOfLine) Determines whether the pointer is currently at the end of a line (right before a newline character set or end of the string)
\$1bool IsNewLine()](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.IsNewLine) Determines whether the pointer is currently at a newline (end of the string is not a newline)
\$1bool IsOutOfBounds()](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.IsOutOfBounds) Determines whether this pointer is currently out of bounds (before or after the string content)
\$1bool IsStartOfLine()](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.IsStartOfLine) Determines whether the pointer is currently at the beginning of a line (right after a newline character set or start of the string)
\$1TextPtr SkipWhitespace(\$1bool])](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.SkipWhitespace) Skips whitespace
\$1bool StartsWith(string)](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.StartsWith) Determines if the current pointer location starts with the given string - in a case sensitive manner.
\$1bool StartsWithCaseInsensitive(string)](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.StartsWithCaseInsensitive) Determines if the current pointer location starts with the given string - in a case insensitive manner.
\$1TextPtr TrimEnd()](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.TrimEnd) Reverses the pointer location until all whitespace is skipped - does not skip newlines
\$1TextPtr TrimStart()](VRage.Game.ModAPI.Ingame.Utilities.TextPtr.TrimStart) Advances the pointer location until all whitespace is skipped - does not skip newlines
Clone this wiki locally