Skip to content

NativeTypes

Reece Sheppard edited this page Jun 22, 2021 · 3 revisions

Native Types

Logical Types

KeywordTypeValues
BoolBoolean logic typetrue
false
EBOOLEnum-based nullable boolUNINITIALZED = 0
FALSE = 1
TRUE = 2

EBOOL seems to only be used by the Cooldown system and as a m_isInitialized field in class ScriptedPuppetPS (presumably legacy code from older RED engine games)

Integer Types

KeywordTypeRange
Int88-bit Signed IntegerCurrently unsupported by the compiler
Uint88-bit Unsigned IntegerCurrently unsupported by the compiler
Int1616-bit Signed IntegerCurrently unsupported by the compiler
Uint1616-bit Unsigned IntegerCurrently unsupported by the compiler
Int3232-bit Signed Integer−2,147,483,648 to 2,147,483,647
Uint3232-bit Unsigned Integer0 to 4,294,967,295
Int6464-bit Signed Integer−9,223,372,036,854,775,808 to 9,223,372,036,854,775,807
Uint6464-bit Unsigned Integer0 to 18,446,744,073,709,551,615

Floating-Point Types

KeywordTypeRange
Float32-bit Single-Precision6-9 significant decimal digits (more info)
Double64-bit Double-Precision15-17 significant decimal digits (more info)

Literal Types

KeywordTypePrefixExample
StringMutable character string"Hello world"
CNameNon-mutable character stringnn"VehicleComponent"
ResRefResource reference pathrr"base\\anim_cooked.cookedanims"
TweakDBIDTweakDB Record IDtt"Items.RequiredItemStats"

String values are stored internally as a null-terminated character array, unfortunately the bytecode doesn't support accessing the individual characters as an array.

CName values are stored in-engine as a 64-bit hash key to a interned string pool. Class, function and field names are stored in the CName pool, so any methods that need a dynamic reference a scripted component will use a CName value.

ResRef values are similar to CName values, except they specifically refer to archive resource files and presumably use a separate optimized string pool. Unlike CName, ResRef doesn't have any defined operators.

TweakDBID is used as the primary key for all *_Record types stored in TweakDB, the engine's internal database. They are represented internally using a composite hash key made from:

  • A CRC-32 hash of the record's name,
  • A byte storing the name length, and
  • 3 bytes for storing the offset of a value within that record

Other Types

KeywordType
VariantA dynamic type that can store any other type

Operators

The RED4 scripting runtime implements most operators as native functions (presumably for speed purposes). Only the equals == and not equals != operators are implemented in bytecode. The redscript compiler provides a number of operator symbols as shorthand.

This table lists the available operators (in precedence block order) and what types support them.

TypeSymbolLogicalIntegerFloatStringCNameTweakDBID
Negate-----
Logical Not!----✓¹
Bitwise Not~-----
Multiplication*-✓²--
Division/----
Modulo%----
Addition+-✓³✓⁴✓⁴
Subtraction-----
Less Than<----
Less Than or Equal<=----
Greater Than>----
Greater Than or Equal>=----
Equals==✓⁵
Not Equals!=✓⁵
Logical And&&-----
Logical Or||-----
Bitwise And&-----
Bitwise Or|-----
Bitwise Xor^-----
Assign=
Assign Add+=--
Assign Subtract-=----
Assign Multiply*=----
Assign Divide/=----
Assign Bitwise Andnone⁶-----
Assign Bitwise Ornone⁶-----

Notes

  1. The Logical Not ! operator for TweakDBID is overridden to return !TDBID.IsValid(a)
  2. Strings can be multiplied by an Int32 to repeat the string:
    publicstaticfunc OperatorMultiply(a:String, count:Int32)->String
  3. String addition is concatenation. There are native functions to allow most types can be concatenated with String
  4. CName and TweakDBID addition is concatenation (and presumably involves some kind of internal lookup to a known value)
  5. The redscript compiler doesn't currently support the == and != symbols for the CName type, use the Equals(a,b) and NotEquals(a,b) intrinsic functions for now.
  6. These functions aren't currently supported by symbol, but native functions exist for each integer type:
    publicstatic native func OperatorAssignAnd(out a:Uint64, b:Uint64)->Uint64
    public static native func OperatorAssignOr(out a:Uint64, b:Uint64)->Uint64

Clone this wiki locally