msw-ai-tf/maplestory-worlds-creator-docs huggingface dataset:
AvatarFaceActionSelectorComponent

This Component selects and applies the avatar's face Action.

# Properties

[{"index":"MapleAvatarFaceActionState ActionState","0":"Current state is Action."}]

[{"index":"float BlinkInterval","0":"Interval between blinks. The unit of measure is the second."}]

[{"index":"ReadOnlyDictionary> StateActionDic (ReadOnly) (HideFromInspector)","0":"Information value about the state. This will be improved later."}]

##### inherited from Component:

[{"index":"boolean Enable (Sync)","0":"Checks whether Component is activated or not."}]

[{"index":"boolean EnableInHierarchy (ReadOnly) (HideFromInspector)","0":"Displays whether this Component is Enable in the hierarchy. If Entity Enable is false regardless of Component Enable, returns false."}]

[{"index":"Entity Entity (ReadOnly)","0":"The Entity that owns this component."}]

# Methods

##### inherited from Component:

[{"index":"boolean IsClient()","0":"Returns whether the current execution environment is a client or not."}]

[{"index":"boolean IsServer()","0":"Returns whether the current execution environment is a server or not."}]
UIAreaParticleType

Particle preset type that is used in UIAreaParticleComponent.

# Members

[{"Name":"nan","Value":"0","Desc":"This is the default. No particles are used."},{"Name":"FogCalm","Value":"1","Desc":"A fog cloud particle."},{"Name":"FogHeavy","Value":"2","Desc":"Descending fog particles."},{"Name":"FogLively","Value":"3","Desc":"Rising fog particles."},{"Name":"CalmStarField","Value":"4","Desc":"Rising star cluster particles."},{"Name":"StarFieldSimple","Value":"5","Desc":"Glittering cluster of star particles."},{"Name":"StarFog","Value":"6","Desc":"A cluster of stars and nebula particles moving in place."},{"Name":"StarFogFlow","Value":"7","Desc":"A cluster of rising stars and nebula particles."}]

# Methods

[{"index":"UIAreaParticleType CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"UIAreaParticleType CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
Item

Represents an item in the world. Includes the configuring information of items.

# Properties

[{"index":"string Description (ReadOnly)","0":"The description of the item defined in the UserItemDataSets table."}]

[{"index":"string GUID (ReadOnly)","0":"The GUID of the item."}]

[{"index":"string IconRUID (ReadOnly)","0":"The IconRUID of the item defined in the UserItemDataSets table."}]

[{"index":"int32 ItemCount","0":"The quantity of the item."}]

[{"index":"string ItemDataTableName (ReadOnly)","0":"The name of the item defined in the UserItemDataSets table."}]

[{"index":"UserDataRow ItemTableData (ReadOnly)","0":"The item data defined in the UserItemDataSets table."}]

[{"index":"string ItemTypeName (ReadOnly)","0":"The script type name of the item."}]

[{"index":"string Owner (ReadOnly)","0":"The owner of the item. Returns UserID or InventoryComponentID."}]

# Methods

[{"index":"int32 GetSize()","0":"Returns the size of the item data."}]
WheelJoint

Connect Entity at a point and have the linked Entity rotate around that point. The connected Entity will act like a wheel. It is used by adding it to Joints of WheelJointComponent.

# Properties

[{"index":"boolean CollideConnected","0":"Sets whether two Entities connected by a Joint will collide with each other."}]

[{"index":"Vector2 LocalAnchorA","0":"Set the Anchor of the Entity with JointComponent. Use relative coordinates based on the Entity."}]

[{"index":"Vector2 LocalAnchorB","0":"Set the Anchor of the Entity connected by Joint. Use relative coordinates based on the Entity."}]

[{"index":"float MaxMotorTorque","0":"Sets the maximum strength applicable to the motor of joint to reach the target motor speed."}]

[{"index":"boolean MotorEnable","0":"Set whether to use the Joint's motor function. If true, the value of MotorSpeed is affected."}]

[{"index":"float MotorSpeed","0":"Set the target motor speed of the Joint."}]

[{"index":"EntityRef TargetEntityRef","0":"Set the Entity to be connected with a Joint."}]

# Constructors

[]

[]
RawImageGUIRendererComponent

Provides the ability to output RawImage to the UI.

# Properties

[{"index":"string MaterialId (Sync)","0":"Specifies the Id of the material to be applied to the renderer."}]

##### inherited from Component:

[{"index":"boolean Enable (Sync)","0":"Checks whether Component is activated or not."}]

[{"index":"boolean EnableInHierarchy (ReadOnly) (HideFromInspector)","0":"Displays whether this Component is Enable in the hierarchy. If Entity Enable is false regardless of Component Enable, returns false."}]

[{"index":"Entity Entity (ReadOnly)","0":"The Entity that owns this component."}]

# Methods

[{"index":"void ChangeMaterial(string materialId)","0":"Replaces the material to be applied to the renderer."}]

[{"index":"void SetRawImage(RawImage rawImage) (ClientOnly)","0":"Draws the RawImage. Does not draw anything if nil is passed."}]

##### inherited from Component:

[{"index":"boolean IsClient()","0":"Returns whether the current execution environment is a client or not."}]

[{"index":"boolean IsServer()","0":"Returns whether the current execution environment is a server or not."}]
SkeletonAnimationTimelineEvent

This event occurs upon detecting an event that was registered to the animation timeline while the skeleton animation is playing.  
  
This event is triggered by the API below.

  * SkeletonGUIRendererComponent (Space;Client)
  * SkeletonRendererComponent (Space;Client)



# Properties

[{"index":"SkeletonAnimationClip AnimationClip","0":"Animation information."}]

[{"index":"string AudioPath","0":"The AudioPath data for the timeline event."}]

[{"index":"float Balance","0":"The Balance data for the timeline event."}]

[{"index":"string EventName","0":"The timeline event name."}]

[{"index":"float Float","0":"The Float data for the timeline event."}]

[{"index":"int32 Int","0":"The Int data for the timeline event."}]

[{"index":"string String","0":"The String data for the timeline event."}]

[{"index":"float Time","0":"The playback time when a timeline event ocurred."}]

[{"index":"float Volume","0":"The Volume data for the timeline event."}]

# Constructors

[{"index":"SkeletonAnimationTimelineEvent()","0":"Resets the SkeletonAnimationTimelineEvent."}]
WorldInstanceInfoPages

Inquires about the World instance list searched from WorldInstanceService in page units.

# Properties

[{"index":"boolean IsLastPage (ReadOnly)","0":"Checks whether the current page is the last."}]

# Methods

[{"index":"table GetCurrentPageDatas() (ServerOnly)","0":"Gets a WorldInstanceInfo list of the current page."}]

[{"index":"boolean MoveToNextPageAndWait() (ServerOnly) (Yield)","0":"Moves to the next page and returns whether the move was successful or not. Script executions are suspended during operation."}]

# Examples

This is an example of traversing through pages.
    
    
    @Component
    script PageIterator extends Component
        @ExecSpace("ServerOnly")
        method void OnBeginPlay()
            while true do
            	local datas = pages:GetCurrentPageData()
            	for _, data in pairs(datas) do
            		log(data.Id)
            	end
            
            	if pages.IsLastPage == true then
            		return
            	end
            
            	local result = pages:MoveToNextPageAndWait()
            	if result == false then
            		return
            	end
            end
        end
    end
    

# SeeAlso

  * WorldInstanceService
BodyActionStateChangeEvent

This event occurs when the BodyAction state changes.  
  
This event is triggered by the API below.

  * AvatarStateAnimationComponent (Space;Server,Client)



# Properties

[{"index":"MapleAvatarBodyActionState ActionState","0":"Changed state."}]

[{"index":"int32 endFrameIndex","0":"Specifies the end frame of the animation played. You cannot exceed the number of total frames of the animation."}]

[{"index":"boolean needResetAction","0":"Forces the target avatar to play from the beginning if it is already playing the same state."}]

[{"index":"float playRate","0":"Controls the play speed of the avatar animation."}]

[{"index":"int32 startFrameIndex","0":"Specifies the start frame of the animation played."}]

# Constructors

[{"index":"BodyActionStateChangeEvent(boolean needResetAction = false, MapleAvatarBodyActionState actionState = MapleAvatarBodyActionState.Invalid, int32 startFrameIndex = 0, int32 endFrameIndex = 2147483647, float playRate = 1)","0":"It is initialized with the specified same play state, BodyAction state, start and stop frames, and play speed."}]
TextHorizontalAlignmentOption

How to align horizontal text.

# Members

[{"Name":"Left","Value":"1","Desc":"Aligns the text to the left."},{"Name":"Center","Value":"2","Desc":"Aligns the text to the center."},{"Name":"Right","Value":"4","Desc":"Aligns the text to the right."},{"Name":"Justified","Value":"8","Desc":"Aligns text to both edges of the text box. Adjusts spacing between words to make all lines the same width. The last line is not aligned to the same width."},{"Name":"Flush","Value":"16","Desc":"Aligns text to both edges of the text box. Adjusts spacing between words to make all lines the same width. The last line adjusts spacing between letters to make the same row width."},{"Name":"Geometry","Value":"32","Desc":"Aligns the text to the center. The center of each line is aligned to the center of the text box."}]

# Methods

[{"index":"TextHorizontalAlignmentOption CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"TextHorizontalAlignmentOption CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
ResourceUploadError

Indicates resource upload success and failure results.

# Members

[{"Name":"Success","Value":"0","Desc":"Resource upload completed."},{"Name":"InternalError","Value":"1","Desc":"Uploading resource failed due to an internal error."},{"Name":"ValidationFailed","Value":"2","Desc":"The upload failed because the producer's request was rejected, and an error occurred while verifying the request."},{"Name":"AlreadyInProgress","Value":"3","Desc":"A previously requested upload did not complete. Only one request is made at a time."},{"Name":"InvalidContent","Value":"4","Desc":"The resource received as a parameter is nil."},{"Name":"HarmfulContent","Value":"412","Desc":"Upload failed because it was determined to be an inappropriate resource."},{"Name":"TooLargeContent","Value":"413","Desc":"Upload failed with a resource exceeding the standard size."},{"Name":"TooManyRequests","Value":"429","Desc":"Upload failed due to too many requests."}]

# Methods

[{"index":"ResourceUploadError CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"ResourceUploadError CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
RectTileCollisionBeginEvent

This event occurs when touching the collidable tile.  
  
This event is triggered by the API below.

  * KinematicbodyComponent (Space;Server,Client)
  * SideviewbodyComponent (Space;Server,Client)



# Properties

[{"index":"Entity Entity","0":"An Entity that collided with a tile."}]

[{"index":"Vector2 Normal","0":"A normal vector of the collided point."}]

[{"index":"Vector2 Point","0":"A collided point."}]

[{"index":"RectTileInfo TileInfo","0":"The detailed information on the tile."}]

[{"index":"RectTileMapComponent TileMap","0":"The RectTileMapComponent to which the tile belongs."}]

[{"index":"Vector2Int TilePosition","0":"The location of the tile."}]

# Constructors

[{"index":"RectTileCollisionBeginEvent(Entity entity = nil, RectTileMapComponent tileMap = nil, Vector2Int tilePosition = Vector2Int(0, 0), RectTileInfo tileInfo = nil, Vector2 point = Vector2(0, 0), Vector2 normal = Vector2(0, 0))","0":"Initializes RectTileCollisionBeginEvent to the specified value."}]
RectTileCollisionEndEvent

This event occurs when being freed from the collided tile.  
  
This event is triggered by the API below.

  * KinematicbodyComponent (Space;Server,Client)
  * SideviewbodyComponent (Space;Server,Client)



# Properties

[{"index":"Entity Entity","0":"An Entity that collided with a tile."}]

[{"index":"Vector2 Normal","0":"A normal vector of the collided point."}]

[{"index":"Vector2 Point","0":"A collided point."}]

[{"index":"RectTileInfo TileInfo","0":"The detailed information on the tile."}]

[{"index":"RectTileMapComponent TileMap","0":"The RectTileMapComponent to which the tile belongs."}]

[{"index":"Vector2Int TilePosition","0":"The location of the tile."}]

# Constructors

[{"index":"RectTileCollisionEndEvent(Entity entity = nil, RectTileMapComponent tileMap = nil, Vector2Int tilePosition = Vector2Int(0, 0), RectTileInfo tileInfo = nil, Vector2 point = Vector2(0, 0), Vector2 normal = Vector2(0, 0))","0":"Initializes RectTileCollisionEndEvent to the specified value."}]
PulleyJoint

Create a line by setting the values of Anchor and GroundAnchor of the two Entities, so the sum of the lines is kept constant. It behaves as if two Entities are connected to a pulley. It is used by adding it to Joints of PullyJointComponent.

# Properties

[{"index":"boolean CollideConnected","0":"Sets whether two Entities connected by a Joint will collide with each other."}]

[{"index":"Vector2 GroundAnchorA","0":"Set the GroundAnchor of the Entity with JointComponent. Use relative coordinates based on the Entity."}]

[{"index":"Vector2 GroundAnchorB","0":"Set the GroundAnchor of the Entity connected by Joint. Use relative coordinates based on the Entity."}]

[{"index":"Vector2 LocalAnchorA","0":"Set the Anchor of the Entity with JointComponent. Use relative coordinates based on the Entity."}]

[{"index":"Vector2 LocalAnchorB","0":"Set the Anchor of the Entity connected by Joint. Use relative coordinates based on the Entity."}]

[{"index":"float Ratio","0":"Sets the binding force ratio of both imaginary lines forming PulleyJoint."}]

[{"index":"EntityRef TargetEntityRef","0":"Set the Entity to be connected with a Joint."}]

# Constructors

[]

[]
RegexOption

Can specify the options needed for regular expressions.

# Members

[{"Name":"nan","Value":"0","Desc":"Does not set options."},{"Name":"IgnoreCase","Value":"1","Desc":"Specifies to ignore case when matching."},{"Name":"Multiline","Value":"2","Desc":"This is multiline mode. Specifies to process the strings as if they are composed of multiple lines."},{"Name":"ExplicitCapture","Value":"4","Desc":"(?...) specifies to only match groups that have been explicitly named or numbered.<\/name>"},{"Name":"Singleline","Value":"16","Desc":"Specifies to process the strings as if they are composed of a single line."},{"Name":"IgnorePatternWhitespace","Value":"32","Desc":"Ignores whitespace without escape characters in the pattern."},{"Name":"RightToLeft","Value":"64","Desc":"Specifies to perform the search from right to left."}]

# Methods

[{"index":"RegexOption CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"RegexOption CastFrom(string value) (Static)","0":"This converts strings to the applicable type."}]

# SeeAlso

  * [Regular Expression Syntax](/docs?postId=1043)
  * [Regular Expressions](/docs?postId=1041)
FootholdCollisionEvent

This event occurs when RigidBodyComponent collides with the foothold.  
  
This event is triggered by the API below.

  * RigidbodyComponent (Space;Server,Client)



# Properties

[{"index":"int32 FootholdId (ReadOnly)","0":"The foothold's Id."}]

[{"index":"Vector2 FootholdNormal (ReadOnly)","0":"The normal direction of the footing."}]

[{"index":"Vector2 ImpactDir (ReadOnly)","0":"Displays the direction that the entity moves upon collision."}]

[{"index":"float ImpactForce (ReadOnly)","0":"The entity's movement speed upon collision."}]

[{"index":"Vector2 ReflectDir (ReadOnly)","0":"The direction the collision is reflected by the foothold."}]

##### inherited from RigidbodyEvent:

[{"index":"RigidbodyComponent Rigidbody (ReadOnly)","0":"The RigidbodyComponent of the generated entity."}]

# Constructors

[{"index":"FootholdCollisionEvent(RigidbodyComponent rigidbody = nil, Vector2 impactDir = Vector2(0, 0), float impactForce = 0, Vector2 footholdNormal = Vector2(0, 0), Vector2 reflectDir = Vector2(0, 0), int32 footholdId = 0)","0":"Initializes FootholdCollisionEvent with the specified value."}]
SkeletonAnimationClip

Displays the properties of animation that are played from SkeletonRendererComponent and SkeletonGUIRendererComponent.

# Properties

[{"index":"float Alpha","0":"Displays the ratio that this is mixed with other tracks. The default value is 1."}]

[{"index":"string AnimationName","0":"The animation name."}]

[{"index":"float Delay","0":"The standby time until the animation will start to play. Time is given in seconds.* If Delay is 0, the animation will play when the previous animation ends.* If Delay is greater than 0, the animation will play Delay seconds after the previous animation starts.* If Delay is less than 0, the animation will play Delay seconds before the previous animation ends."}]

[{"index":"boolean Loop","0":"Indicates whether this will play on loop."}]

[{"index":"float MixDuration","0":"This is the amount of time that the animation will be mixed with the previous one when transitioning between animations. Time is given in seconds."}]

[{"index":"float TimeScale","0":"The animation play speed. The default value is 1."}]

[{"index":"int32 TrackIndex","0":"The track number from which the animation will be played."}]

# Constructors

[{"index":"SkeletonAnimationClip()","0":"Resets SkeletonAnimationClip to the specified value."}]
DataStorage

This type is deprecated. Please use GetGlobalDataStorage(string), GetUserDataStorage(string), GetCreatorDataStorage(), or GetSortableDataStorage(string) of DataStorageService for the intended use.

# Methods

[{"index":"string GetAndWait(string key) (Deprecated) (ServerOnly) (Yield)","0":"This function is deprecated. Please use the GetAndWait() function of GlobalDataStorage, UserDataStorage, CreatorDataStorage, or SortableDataStorage for the intended use."}]

[{"index":"void GetAsync(string key, func callbackFunction) (Deprecated) (ServerOnly)","0":"This function is deprecated. Please use the GetAsync() function of GlobalDataStorage, UserDataStorage, CreatorDataStorage, or SortableDataStorage for the intended use."}]

[{"index":"boolean SetAndWait(string key, string value) (Deprecated) (ServerOnly) (Yield)","0":"This function is deprecated. Please use the SetAndWait() function of GlobalDataStorage, UserDataStorage, CreatorDataStorage, or SortableDataStorage for the intended use."}]

[{"index":"void SetAsync(string key, string value, func callbackFunction) (Deprecated) (ServerOnly)","0":"This function is deprecated. Please use the SetAsync() function of GlobalDataStorage, UserDataStorage, CreatorDataStorage, or SortableDataStorage for the intended use."}]
SpriteParticleType

Particle preset type used by SpriteParticleComponent.

# Members

[{"Name":"nan","Value":"0","Desc":"This is the default. No particles are being used."},{"Name":"BurstBig","Value":"1","Desc":"The specified sprite appears with a spreading circular effect."},{"Name":"SpawnField","Value":"2","Desc":"Several small particles and the specified sprite appear together in a circle area."},{"Name":"BurstNova","Value":"3","Desc":"Small particles and specified sprites explode in a circle area."},{"Name":"SimpleSpawn","Value":"4","Desc":"Small particles and the specified sprite appear."},{"Name":"Burst","Value":"5","Desc":"Small particles and the specified sprite appear spread out."},{"Name":"Stream","Value":"6","Desc":"Small particles and specified sprites are created moving in a certain direction."},{"Name":"StreamSharp","Value":"7","Desc":"Small particles and specified sprites are created with thin lines moving in a certain direction."},{"Name":"AdditiveColor","Value":"8","Desc":"Applies a color effect to the specified sprite."}]

# Methods

[{"index":"SpriteParticleType CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"SpriteParticleType CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
MobileShareService

Enables the user to share images taken with ScreenshotService or videos recorded by ScreenRecordService on social media.\nOnly available on mobile devices.

# Methods

[{"index":"boolean ShareFileAndWait(string filePath) (ClientOnly) (Yield)","0":"Shares a video or image in a filePath. Returns false if a file does not exist or fails to be shared."}]

##### inherited from Service:

[{"index":"EventHandlerBase ConnectEvent(string key, IScriptFunction eventHandler)","0":"Links events. When a key-type event occurs in this service, a handler is notified. The handler receives event parameters."}]

[{"index":"EventHandlerBase ConnectEvent(Type eventType, IScriptFunction eventHandler)","0":"Links events. This service notifies a handler when an eventType event occurs. The handler receives event parameters."}]

[{"index":"boolean DisconnectEvent(string key, EventHandlerBase eventHandler)","0":"Disconnects the event with the key-type event and the handler."}]

[{"index":"boolean DisconnectEvent(Type eventType, EventHandlerBase eventHandler)","0":"Disconnects the eventType event from its handler."}]

[{"index":"void SendEvent(EventType sendEvent)","0":"Generates an event."}]

# SeeAlso

  * ScreenRecordService
  * ScreenshotService
  * [Record and Share Game Screen](/docs?postId=997)
ChildAlignmentType

The alignment type of the child Entity.

# Members

[{"Name":"UpperLeft","Value":"0","Desc":"The alignment reference position is the top left of the parent."},{"Name":"UpperCenter","Value":"1","Desc":"The alignment reference position is the top center of the parent."},{"Name":"UpperRight","Value":"2","Desc":"The alignment reference position is the top right of the parent."},{"Name":"MiddleLeft","Value":"3","Desc":"The alignment reference position is the left center of the parent."},{"Name":"MiddleCenter","Value":"4","Desc":"The alignment reference position is the center of the parent."},{"Name":"MiddleRight","Value":"5","Desc":"The alignment reference position is the right center of the parent."},{"Name":"LowerLeft","Value":"6","Desc":"The alignment reference position is the bottom left of the parent."},{"Name":"LowerCenter","Value":"7","Desc":"The alignment reference position is the bottom center of the parent."},{"Name":"LowerRight","Value":"8","Desc":"The alignment reference position is the bottom right of the parent."}]

# Methods

[{"index":"ChildAlignmentType CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"ChildAlignmentType CastFrom(string value) (Static)","0":"This converts strings to the applicable type."}]
UISpriteParticleType

Particle preset type used by UISpriteParticleComponent.

# Members

[{"Name":"nan","Value":"0","Desc":"This is the default. No particles are used."},{"Name":"BurstBig","Value":"1","Desc":"The specified sprite appears with a spreading circular effect."},{"Name":"SpawnField","Value":"2","Desc":"Several small particles and the specified sprite appear together in a circle area."},{"Name":"BurstNova","Value":"3","Desc":"Small particles and specified sprites explode in a circle area."},{"Name":"SimpleSpawn","Value":"4","Desc":"Small particles and the specified sprite appear."},{"Name":"Burst","Value":"5","Desc":"Small particles and the specified sprite appear spread out."},{"Name":"Stream","Value":"6","Desc":"Small particles and specified sprites are created moving in a certain direction."},{"Name":"StreamSharp","Value":"7","Desc":"Small particles and specified sprites are created with thin lines moving in a certain direction."},{"Name":"AdditiveColor","Value":"8","Desc":"Applies a color effect to the specified sprite."}]

# Methods

[{"index":"UISpriteParticleType CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"UISpriteParticleType CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]