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

Initializes SpriteAnimPlayerEndEvent to the specified value.  
  
This event is triggered by the API below.

  * SpriteGUIRendererComponent (Space;Client)



# Properties

[{"index":"Entity Entity","0":"The entity affected by the event."}]

[{"index":"int32 FrameIndex (ReadOnly)","0":"The frame number."}]

[{"index":"boolean ReversePlaying (ReadOnly)","0":"Indicates whether to play in reverse."}]

[{"index":"int32 TotalFrameCount (ReadOnly)","0":"Total number of frames to make up the sprite animation."}]

# Constructors

[{"index":"SpriteGUIAnimPlayerEndFrameEvent(Entity entity = nil, int32 frameIndex = -1, boolean reversePlaying = false, int32 totalFrameCount = 0)","0":"Initializes SpriteGUIAnimPlayerEndFrameEvent to the specified value."}]
SpriteGUIAnimPlayerChangeFrameEvent

This event is raised when changing the sprite animation's frame.  
  
This event is triggered by the API below.

  * SpriteGUIRendererComponent (Space;Client)



# Properties

[{"index":"Entity Entity","0":"The entity affected by the event."}]

[{"index":"int32 FrameIndex (ReadOnly)","0":"The updated frame number."}]

[{"index":"boolean ReversePlaying (ReadOnly)","0":"Indicates whether to play in reverse."}]

[{"index":"int32 TotalFrameCount (ReadOnly)","0":"Total number of frames to make up the sprite animation."}]

# Constructors

[{"index":"SpriteGUIAnimPlayerChangeFrameEvent(Entity entity = nil, int32 frameIndex = -1, boolean reversePlaying = false, int32 totalFrameCount = 0)","0":"Initializes SpriteGUIAnimPlayerChangeFrameEvent to the specified value."}]
SpriteGUIAnimPlayerStartFrameEvent

This event is raised when playing the first frame of sprite animation.  
  
This event is triggered by the API below.

  * SpriteGUIRendererComponent (Space;Client)



# Properties

[{"index":"Entity Entity","0":"The entity affected by the event."}]

[{"index":"int32 FrameIndex (ReadOnly)","0":"The frame number."}]

[{"index":"boolean ReversePlaying (ReadOnly)","0":"Indicates whether to play in reverse."}]

[{"index":"int32 TotalFrameCount (ReadOnly)","0":"Total number of frames to make up the sprite animation."}]

# Constructors

[{"index":"SpriteGUIAnimPlayerStartFrameEvent(Entity entity = nil, int32 frameIndex = -1, boolean reversePlaying = false, int32 totalFrameCount = 0)","0":"Initializes SpriteGUIAnimPlayerStartFrameEvent to the specified value."}]
Service

This is the superclass of all Services. Provides basic functions of Service.

# Methods

[{"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."}]
SpriteAnimPlayerStartEvent

This event is raised when starting the sprite animation's playback.  
  
This event is triggered by the API below.

  * ClimbableSpriteRendererComponent (Space;Client)
  * SpriteRendererComponent (Space;Client)



# Properties

[{"index":"float ClipPlayRate (ReadOnly)","0":"Clip playback speed."}]

[{"index":"SpriteAnimClipPlayType ClipPlayType (ReadOnly)","0":"How to play a clip."}]

##### inherited from SpriteAnimPlayerEvent:

[{"index":"IEmbeddedSpriteAnimPlayer AnimPlayer (ReadOnly)","0":"The animation player."}]

# Constructors

[{"index":"SpriteAnimPlayerStartEvent(IEmbeddedSpriteAnimPlayer animPlayer = nil, SpriteAnimClipPlayType clipPlayType = SpriteAnimClipPlayType.Onetime, float clipPlayRate = 1)","0":"Initializes SpriteAnimPlayerStartEvent to the specified value."}]
TotalServerFunctionRateLimitEvent

This event occurs when the total number of calls to the server execution control function exceeds the limit.  
  
This event is triggered by the API below.

  * RateLimitService (Space;Server)



# Properties

[{"index":"string EntityId","0":"The entity's Id to which the funtion's component belongs."}]

[{"index":"string FunctionName","0":"The function name."}]

[{"index":"string ProfileCode","0":"The profile code for the user who called the function."}]

[{"index":"string TypeName","0":"The name of the component, service, or logic to which the function belongs."}]

# Constructors

[{"index":"TotalServerFunctionRateLimitEvent(string profileCode = nil, string entityId = nil, string typeName = nil, string functionName = nil)","0":"Initializes a TotalServerFunctionRateLimitEvent with the specified value."}]
GridLayoutCorner

The starting position for aligning child UI entities according to the size of the parent entity. You can set if ScrollLayoutComponent is GridType.

# Members

[{"Name":"UpperLeft","Value":"0","Desc":"Arrange child UI entities by adding them from the top left."},{"Name":"UpperRight","Value":"1","Desc":"Arrange child UI entities by adding them from the top right."},{"Name":"LowerLeft","Value":"2","Desc":"Arrange child UI entities by adding them from the bottom left."},{"Name":"LowerRight","Value":"3","Desc":"Arrange child UI entities by adding them from the bottom right."}]

# Methods

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

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

This Component is deprecated. Use StateAnimationComponent.

# Properties

##### 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."}]

# Events

[{"index":"MonsterActionStateEvent","0":"This is a deprecated event. Use StateAnimationComponent."}]
UserDisconnectEvent

This event occurs when the user's network connection is unstable or disconnected.  
  
This event is triggered by the API below.

  * UserService (Space;Server)



# Properties

[{"index":"string DisconnectMapName","0":"The name of the map where the user was disconnected."}]

[{"index":"string ProfileCode","0":"This player's profile code."}]

[{"index":"DateTime TimeNetworkClosed","0":"Time when the user was disconnected."}]

[{"index":"string UserId","0":"The user's unique identifier."}]

# Constructors

[{"index":"UserDisconnectEvent(IUser user)","0":"Initializes UserDisconnectEvent to the specified value."}]

[{"index":"UserDisconnectEvent(string disconnectMapName = nil, DateTime timeNetworkClosed = nil, string userId = nil, string profileCode = nil)","0":"Initializes UserDisconnectEvent to the specified value."}]
UserReconnectEvent

This event occurs when the user reconnects.  
  
This event is triggered by the API below.

  * UserService (Space;Server)



# Properties

[{"index":"string ProfileCode","0":"This player's profile code."}]

[{"index":"string ReconnectMapName","0":"The name of the map the user reconnected to."}]

[{"index":"DateTime TimeNetworkClosed","0":"Time when the user was disconnected."}]

[{"index":"string UserId","0":"The user's unique identifier."}]

# Constructors

[{"index":"UserReconnectEvent(IUser user)","0":"Initializes UserReconnectEvent to the specified value."}]

[{"index":"UserReconnectEvent(string reconnectMapName = nil, DateTime timeNetworkClosed = nil, string userId = nil, string profileCode = nil)","0":"Initializes UserReconnectEvent to the specified value."}]
LightType

The LightComponent lighting type.

# Members

[{"Name":"Spot","Value":"0","Desc":"A circular light source and can be composed as a pizza slice shape as well. Not affected by TransformComponent Scale."},{"Name":"Freeform","Value":"1","Desc":"This lighting is based on a user-customized, closed, multi-point shape."},{"Name":"Global","Value":"2","Desc":"This lighting affects the entire screen with a defined shape. Individual SortingLayers can't be affected by multiple Global Light lighting effects at the same time."},{"Name":"Sprite","Value":"3","Desc":"This lighting is based on a sprite."}]

# Methods

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

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

This event occurs when the number of calls to the server execution control function of a specific component, service, or logic exceeds the limit.  
  
This event is triggered by the API below.

  * RateLimitService (Space;Server)



# Properties

[{"index":"string EntityId","0":"The entity's Id to which the funtion's component belongs."}]

[{"index":"string FunctionName","0":"The function name."}]

[{"index":"string ProfileCode","0":"The profile code for the user who called the function."}]

[{"index":"string TypeName","0":"The name of the component, service, or logic to which the function belongs."}]

# Constructors

[{"index":"ServerFunctionRateLimitEvent(string profileCode = nil, string entityId = nil, string typeName = nil, string functionName = nil)","0":"Initializes ServerFunctionRateLimitEvent with the specified value."}]
ScreenshotError

Indicates the screenshot capture result.

# Members

[{"Name":"Success","Value":"0","Desc":"Screenshot capture succeeded."},{"Name":"PlatformNotSupported","Value":"1","Desc":"Screenshot capture is not supported on this device."},{"Name":"InvalidFileName","Value":"2","Desc":"An invalid file name."},{"Name":"TooFrequentFileWrite","Value":"3","Desc":"Attempts to save screenshots are too frequent."},{"Name":"InternalError","Value":"4","Desc":"Capture failed with an internal error."},{"Name":"NoPermissionToPhotoLibrary","Value":"5","Desc":"You do not have permission to save to your photo library."}]

# Methods

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

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

An event that occurs when a touch or mouse input enters the UI Entity.  
  
This event is triggered by the API below.

  * UITouchReceiveComponent (Space;Client)



# Properties

[{"index":"Entity Entity","0":"The Entity affected by the event."}]

[{"index":"int32 TouchId","0":"The identifier that uniquely represents a specific input type. For example, left mouse click is -1, center mouse click is -2, and right mouse click is -3. Touch inputs on mobile devices are incremented starting from 1."}]

[{"index":"Vector2 TouchPoint","0":"The screen coordinates where the event occurred."}]

# Constructors

[{"index":"UITouchEnterEvent(Entity entity = nil, int32 touchId = 0, Vector2 touchPoint = Vector2(0, 0))","0":"Initializes UITouchEnterEvent to the specified value."}]
UITouchExitEvent

An event that occurs when a touch or mouse input leaves the UI Entity.  
  
This event is triggered by the API below.

  * UITouchReceiveComponent (Space;Client)



# Properties

[{"index":"Entity Entity","0":"The Entity affected by the event."}]

[{"index":"int32 TouchId","0":"The identifier that uniquely represents a specific input type. For example, left mouse click is -1, center mouse click is -2, and right mouse click is -3. Touch inputs on mobile devices are incremented starting from 1."}]

[{"index":"Vector2 TouchPoint","0":"The screen coordinates where the event occurred."}]

# Constructors

[{"index":"UITouchExitEvent(Entity entity = nil, int32 touchId = 0, Vector2 touchPoint = Vector2(0, 0))","0":"Initializes UITouchExitEvent to the specified value."}]
UITouchBeginDragEvent

An event that occurs when a mouse drag starts on the UI Entity.  
  
This event is triggered by the API below.

  * UITouchReceiveComponent (Space;Client)



# Properties

[{"index":"Entity Entity","0":"The Entity affected by the event."}]

[{"index":"int32 TouchId","0":"The identifier that uniquely represents a specific input type. For example, left mouse click is -1, center mouse click is -2, and right mouse click is -3. Touch inputs on mobile devices are incremented starting from 1."}]

[{"index":"Vector2 TouchPoint","0":"The screen coordinates where the event occurred."}]

# Constructors

[{"index":"UITouchBeginDragEvent(Entity entity = nil, int32 touchId = 0, Vector2 touchPoint = Vector2(0, 0))","0":"Initializes UITouchBeginDragEvent to the specified value."}]
UITouchEndDragEvent

An event that occurs when a mouse drag input ends on the UI Entity.  
  
This event is triggered by the API below.

  * UITouchReceiveComponent (Space;Client)



# Properties

[{"index":"Entity Entity","0":"The Entity affected by the event."}]

[{"index":"int32 TouchId","0":"The identifier that uniquely represents a specific input type. For example, left mouse click is -1, center mouse click is -2, and right mouse click is -3. Touch inputs on mobile devices are incremented starting from 1."}]

[{"index":"Vector2 TouchPoint","0":"The screen coordinates where the event occurred."}]

# Constructors

[{"index":"UITouchEndDragEvent(Entity entity = nil, int32 touchId = 0, Vector2 touchPoint = Vector2(0, 0))","0":"Initializes UITouchEndDragEvent to the specified value."}]
UITouchUpEvent

An event that occurs when a touch or mouse input is released on the UI Entity.  
  
This event is triggered by the API below.

  * UITouchReceiveComponent (Space;Client)



# Properties

[{"index":"Entity Entity","0":"The entity affected by the event."}]

[{"index":"int32 TouchId","0":"The identifier that uniquely represents a specific input type. For example, left mouse click is -1, center mouse click is -2, and right mouse click is -3. Touch inputs on mobile devices are incremented starting from 1."}]

[{"index":"Vector2 TouchPoint","0":"The screen coordinates where the event occurred."}]

# Constructors

[{"index":"UITouchUpEvent(Entity entity = nil, int32 touchId = 0, Vector2 touchPoint = Vector2(0, 0))","0":"Initializes UITouchUpEvent to the specified value."}]
UIGroupType

Indicates the UI group type. Creators can freely modify UIGroupType for all UIGroup.

# Members

[{"Name":"nan","Value":"0","Desc":"Currently not used."},{"Name":"DefaultType","Value":"1","Desc":"A default UIGroup. It is automatically created when the World is first created. Cannot be deleted if it's set to DefaultType."},{"Name":"UIType","Value":"2","Desc":"A UI group created in the UI Editor."},{"Name":"EditorType","Value":"3","Desc":"A UI group created in the UI Editor. This becomes an Editor UIGroup available for use when editing Scene."}]

# Methods

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

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

This code represents the results of requests related to room and world instance events.

# Members

[{"Name":"OK","Value":"0","Desc":"Request processing was successful."},{"Name":"Cancelled","Value":"1000000","Desc":"Request cancelled."},{"Name":"InternalError","Value":"1000001","Desc":"An internal system error has occurred."},{"Name":"BadRequest","Value":"1000003","Desc":"Invalid request."},{"Name":"ResourceExhausted","Value":"1000005","Desc":"Failed due to high request volume."},{"Name":"Unknown","Value":"2147483647","Desc":"An unknown error has occurred."}]

# Methods

[{"index":"SendEventRequestResultCode CastFrom(number value) (Static)","0":"Converts a number to its type."}]

[{"index":"SendEventRequestResultCode CastFrom(string value) (Static)","0":"Converts a string to its type."}]
UITouchDownEvent

An event that occurs when a touch or a mouse button input is made on the UI Entity.  
  
This event is triggered by the API below.

  * UITouchReceiveComponent (Space;Client)



# Properties

[{"index":"Entity Entity","0":"The Entity affected by the event."}]

[{"index":"int32 TouchId","0":"The identifier that uniquely represents a specific input type. For example, left mouse click is -1, center mouse click is -2, and right mouse click is -3. Touch inputs on mobile devices are incremented starting from 1."}]

[{"index":"Vector2 TouchPoint","0":"The screen coordinates where the event occurred."}]

# Constructors

[{"index":"UITouchDownEvent(Entity entity = nil, int32 touchId = 0, Vector2 touchPoint = Vector2(0, 0))","0":"Initializes UITouchDownEvent to the specified value."}]
BadgeStatus

Indicates the registration state of the badge.

# Members

[{"Name":"Register","Value":"0","Desc":"Registering badges. It is displayed as 'Registration in progress' on the official website."},{"Name":"Ing","Value":"1","Desc":"You can earn badges. It is displayed as Obtainable on the official website."},{"Name":"Waiting","Value":"2","Desc":"Waiting for badges to be acquired. It is displayed as Waiting on the official website."},{"Name":"End","Value":"3","Desc":"You cannot earn badges. It is displayed as Unobtainable on the official website."},{"Name":"Deleted","Value":"4","Desc":"Deleted badge."}]

# Methods

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

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

Show a collision group.

# Properties

[{"index":"string Id (ReadOnly)","0":"The identifier for this collision group."}]

# Methods

[{"index":"table GetCollideGroups()","0":"Get collision groups that collide with this collision group as a table."}]

# Examples

This is an example of handling collision groups.
    
    
    @Component
    script CollisionGroupSetter extends Component
        @ExecSpace("ServerOnly")
        method void OnBeginPlay()
            local trigger = self.Entity.TriggerComponent
            local group = trigger.CollisionGroup
            
            log (group)            -- 'collisiongroup/identifier'
            log (group.Id)         -- identifier
            log (tostring(group))  -- 'collisiongroup/identifier'
            
            -- Changes the collision group. You can access the default collision group and any creator-made collision groups with CollisionGroups.
            trigger.CollisionGroup = CollisionGroups.Default
        end
    end
WeldJoint

Constrains the relative rotation and movement of two Entities. It is used by adding it to Joints of WeldJointComponent.

# 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":"EntityRef TargetEntityRef","0":"Set the Entity to be connected with a Joint."}]

# Constructors

[{"index":"WeldJoint()","0":"Initializes WeldJoint to the default value."}]

[{"index":"WeldJoint(WeldJoint joint)","0":"Initializes WeldJoint to the same value as the specified joint."}]
StateStringToAvatarActionComponent

This Component connects the appropriate Avatar Action State to the StateComponent's State to deliver it to the AvatarRendererComponent.

# Properties

##### 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."}]

# Events

[{"index":"BodyActionStateChangeEvent","0":"This event occurs when the BodyAction state changes."}]
Creating a game with MapleStory Worlds

$$youtube /watch?v=R-_oQ_yccQE&list=PL_YzGDiuUdWuPSbbtd94tLreH064P9Z3w $$

  1. Create a game with MapleStory Worlds
  2. Explore the main menu
  3. Map & Character Placement
  4. Create a Monster Portal
  5. Create a Monster
  6. Attacking Monsters
  7. Server/Client
  8. OnUpdate Function
  9. Spawning Monsters
  10. Character Status
  11. Attack1 - Create Missile
  12. Attack2 - move missile
  13. Attack3 - missile attack
  14. Attack4 - monster hit
  15. Attack5 - monster HP
  16. Attack6 - attack direction
  17. Manual attack
  18. HP UI
DecoratorNode

This is the control node that determines the child node's execution state or changes the result value.

# Properties

##### inherited from BTNode:

[{"index":"boolean ExclusiveExecutionWhenRunning (Deprecated)","0":"This property is deprecated."}]

[{"index":"func InitFunction","0":"Initialization calls this function."}]

[{"index":"string Name","0":"The name of the node."}]

[{"index":"AIComponent ParentAI (ReadOnly) (HideFromInspector)","0":"AIComponent to have the node."}]

# Methods

[{"index":"BehaviourTreeStatus ChildBehave(float deltaTime)","0":"This executes the decorator's child node. deltaTime represents the time that passed between the previous frame and the current frame in units of seconds."}]

##### inherited from BTNode:

[{"index":"BehaviourTreeStatus Behave(float deltaTime)","0":"Executes the node. The deltaTime refers to the duration between the previous frame and the current frame. Defined in seconds."}]
GlobalTypeOverlayLightInfo

The information about a Global-type light source that will spawn in the map.

# Properties

[{"index":"Color Color","0":"The color of the light source."}]

[{"index":"Entity Instigator","0":"An entity that belongs to the map where a light source will be added."}]

[{"index":"float Intensity","0":"The intensity of the light source."}]

[{"index":"float Lifetime","0":"The amount of time the light source will display. The created light source will automatically disappear upon reaching the specified time. However, when a value equal to or lower than 0 is input, the light source will remain indefinitely."}]

# Constructors

[{"index":"GlobalTypeOverlayLightInfo(Entity instigator)","0":"Initializes GlobalTypeOverlayLightInfo to the specified value."}]

[{"index":"GlobalTypeOverlayLightInfo(Entity instigator, float lifetime, Color color, float intensity)","0":"Initializes GlobalTypeOverlayLightInfo to the specified value."}]
SpriteAnimPlayerChangeFrameEvent

This event is raised when changing the sprite animation's frame.  
  
This event is triggered by the API below.

  * ClimbableSpriteRendererComponent (Space;Client)
  * SpriteRendererComponent (Space;Client)



# Properties

[{"index":"int32 FrameIndex (ReadOnly)","0":"The updated frame number."}]

[{"index":"boolean ReversePlaying (ReadOnly)","0":"Indicates whether to play in reverse."}]

[{"index":"int32 TotalFrameCount (ReadOnly)","0":"Total number of frames to make up the sprite animation."}]

##### inherited from SpriteAnimPlayerEvent:

[{"index":"IEmbeddedSpriteAnimPlayer AnimPlayer (ReadOnly)","0":"The animation player."}]

# Constructors

[{"index":"SpriteAnimPlayerChangeFrameEvent(IEmbeddedSpriteAnimPlayer animPlayer = nil, int32 frameIndex = -1, boolean reversePlaying = false, int32 totalFrameCount = 0)","0":"Initializes SpriteAnimPlayerChangeFrameEvent to the specified value."}]