Module Schema

Schema related utilities

Class EnumerationItem

EnumerationItem:initialize (input) Init

Class Enumeration

Enumeration:initialize (input) Init
EnumerationItem:GetEnumItems () Get all enum items

Class Schema

Schema.static.Enums All enums get placed in this table

Simple

Schema.static.IntegerFrom (min, max) Match a range from and to
Schema.static.CamelCase

Matches camelcase pretty poorly

Lua has crap regexp support
Schema.static.StringLength (min, max) StringLength matching

Roblox

Schema.static:TypeOf (className) Type of roblox instance
Schema.static:IsA (className) IsA like for roblox instances
Schema.static:InstanceName (name) Matches instance name
Schema.static.PlaceId PlaceId is a number

Logging

Schema.static.Enums.LogLevel Logging level
Schema.static.LogEntry Represents a log entry
Schema.static.LogInit Logging initialization data

Components

Schema.static.IsARoot IsARoot Instance
Schema.static.Component (obj, path) Does the object have a component attached.
Schema.static.CharacterModel Is this a character model?
Schema.static.ComponentName Is the data a valid component name?
Schema.static.ComponentScript A calling component script
Schema.static.ComponentQuery Component Query
Schema.static.Root Is this a valid root object, and does it have a component attached.

Scripts

Schema.static.Script Is this a script

Data

Schema.static.DataFolder A valid data key
Schema.static.DataKey Data key
Schema.static.DataType Type
Schema.static.DataValue Value
Schema.static.DataDefinition Data definition

Properties

Schema.static.PropertyDefinition Property definition

Configuraton

Schema.static.ConfigurationKey key
Schema.static.ConfigurationFolder folder

Events

Schema.static.Enums.InputEventType Input event type
Schema.static.Message An general message
Schema.static.DamagePayload A damage message
Schema.static.DamageMax max
Schema.static.DamageAmount amount

Assets

Schema.static.AssetData data

URL

Schema.static.HttpURL http url
Schema.static.HttpsURL https

Currency

Schema.static.MaximumCurrency max
Schema.static.Currency currency

Weapons

Schema.static.Enums.WeaponType type
Schema.static.WeaponType type
Schema.static.MaxAttackDistance max attack dist
Schema.static.AttackDistance attack dist


Class EnumerationItem

Represents an item
EnumerationItem:initialize (input)
Init

Parameters:

  • input

Class Enumeration

An eneumeration
Enumeration:initialize (input)
Init

Parameters:

  • input
EnumerationItem:GetEnumItems ()
Get all enum items

Returns:

    {table}

Class Schema

Schema utility class
Schema.static.Enums
All enums get placed in this table

Simple

Schema.static.IntegerFrom (min, max)
Match a range from and to

Parameters:

  • min int
  • max int

Returns:

    func
Schema.static.CamelCase

Matches camelcase pretty poorly

Lua has crap regexp support
Schema.static.StringLength (min, max)
StringLength matching

Parameters:

  • min int
  • max int

Returns:

    func

Roblox

Schema.static:TypeOf (className)
Type of roblox instance

Parameters:

  • className
Schema.static:IsA (className)
IsA like for roblox instances

Parameters:

  • className
Schema.static:InstanceName (name)
Matches instance name

Parameters:

  • name
Schema.static.PlaceId
PlaceId is a number

Logging

Schema.static.Enums.LogLevel
Logging level
Schema.static.LogEntry
Represents a log entry
Schema.static.LogInit
Logging initialization data

Components

Schema.static.IsARoot
IsARoot Instance
Schema.static.Component (obj, path)
Does the object have a component attached.

Parameters:

  • obj
  • path
Schema.static.CharacterModel
Is this a character model?
Schema.static.ComponentName
Is the data a valid component name?
Schema.static.ComponentScript
A calling component script
Schema.static.ComponentQuery
Component Query
Schema.static.Root
Is this a valid root object, and does it have a component attached.

Scripts

Schema.static.Script
Is this a script

Data

Schema.static.DataFolder
A valid data key
Schema.static.DataKey
Data key
Schema.static.DataType
Type
Schema.static.DataValue
Value
Schema.static.DataDefinition
Data definition

Properties

Schema.static.PropertyDefinition
Property definition

Configuraton

Schema.static.ConfigurationKey
key
Schema.static.ConfigurationFolder
folder

Events

Schema.static.Enums.InputEventType
Input event type
Schema.static.Message
An general message
Schema.static.DamagePayload
A damage message
Schema.static.DamageMax
max
Schema.static.DamageAmount
amount

Assets

Schema.static.AssetData
data

URL

Schema.static.HttpURL
http url
Schema.static.HttpsURL
https

Currency

Schema.static.MaximumCurrency
max
Schema.static.Currency
currency

Weapons

Schema.static.Enums.WeaponType
type
Schema.static.WeaponType
type
Schema.static.MaxAttackDistance
max attack dist
Schema.static.AttackDistance
attack dist
generated by LDoc 1.4.6 Last updated 2018-06-18 20:55:46