userdata

This page describes helper functions for userdata objects that have been added as part of modding API.

 

• GetUserdataType
• modApi.isUserdataClass
• modApi.isUserdataInstance
• Game:GetUserdataType
• Board:GetUserdataType
• Pawn:GetUserdataType
• PAWN_FACTORY:GetUserdataType
• Point:GetUserdataType
• SkillEffect:GetUserdataType
• SpaceDamage:GetUserdataType

 

GetUserdataType

Argument name	Type	Description
userdata	userdata	The userdata object we want to query

returns a string of the userdata type of the specified userdata, or "Unknown", if the userdata does not have a GetUserdataType function.

 

modApi.isUserdataClass

Argument name	Type	Description
userdata	userdata	The userdata object we want to query

returns true if the userdata object is a class, otherwise, false.

 

modApi.isUserdataInstance

Argument name	Type	Description
userdata	userdata	The userdata object we want to query

returns true if the userdata object is an instance of a class, otherwise, false.

 

Game:GetUserdataType

returns "Game"

 

Board:GetUserdataType

returns "Board"

 

Pawn:GetUserdataType

returns "Pawn"

 

PAWN_FACTORY:GetUserdataType

returns "PAWN_FACTORY"

 

Point:GetUserdataType

returns "Point" if it is a class instance, or "PointClass" if it is the Point class itself.

 

SkillEffect:GetUserdataType

returns "SkillEffect" if it is a class instance, or "SkillEffectClass" if it is the SkillEffect class itself.

 

SpaceDamage:GetUserdataType

returns "SpaceDamage" if it is a class instance, or "SpaceDamageClass" if it is the SpaceDamage class itself.